The cl-zipper Reference Manual

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 4.0 beta 2 "William Riker" on Mon Aug 15 04:10:41 2022 GMT+0.

Table of Contents


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.


2 Systems

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


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

2.1 cl-zipper

An implementation of functional zippers for Common Lisp

Author

inaimathi <leo.zovic@gmail.com>

License

MIT Expat

Version

0.0.1

Source

cl-zipper.asd.

Child Component

src (module).


3 Modules

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


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

3.1 cl-zipper/src

Source

cl-zipper.asd.

Parent Component

cl-zipper (system).

Child Components

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   [Contents][Index]

4.1.1 cl-zipper/cl-zipper.asd

Source

cl-zipper.asd.

Parent Component

cl-zipper (system).

ASDF Systems

cl-zipper.


4.1.2 cl-zipper/src/package.lisp

Source

cl-zipper.asd.

Parent Component

src (module).

Packages

cl-zipper.


4.1.3 cl-zipper/src/util.lisp

Source

cl-zipper.asd.

Parent Component

src (module).

Internals

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

Source

cl-zipper.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 cl-zipper

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


6.1.1 Ordinary functions

Function: append-child (zipper node)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: branch? (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: children (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: delete (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: down (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: edit (zipper f &rest args)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: find (zipper f)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: insert-child (zipper node)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: insert-left (zipper node)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: insert-right (zipper node)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: left (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: leftmost (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: lefts (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: make-node (zipper children)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: next (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: node (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: path (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: prev (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: remove (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: replace (zipper node)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: right (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: rightmost (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: rights (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: root (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: splice-left (zipper node-list)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: splice-right (zipper node-list)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: up (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: zipper (branch? children make-node root)
Package

cl-zipper.

Source

cl-zipper.lisp.


6.1.2 Generic functions

Generic Function: make-zipper (thing)
Package

cl-zipper.

Methods
Method: make-zipper ((thing list))
Source

cl-zipper.lisp.


6.1.3 Structures

Structure: path
Package

cl-zipper.

Source

cl-zipper.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: left
Readers

path-left.

Writers

(setf path-left).

Slot: path
Readers

path-path.

Writers

(setf path-path).

Slot: right
Readers

path-right.

Writers

(setf path-right).


6.2 Internals


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

6.2.1 Macros

Macro: -> (exp &rest ops)
Package

cl-zipper.

Source

util.lisp.

Macro: if-let ((name test) then &optional else)
Package

cl-zipper.

Source

util.lisp.


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

6.2.2 Ordinary functions

Reader: api-fn-branch? (instance)
Writer: (setf api-fn-branch?) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

fn-branch?.

Reader: api-fn-children (instance)
Writer: (setf api-fn-children) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

fn-children.

Reader: api-fn-make-node (instance)
Writer: (setf api-fn-make-node) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

fn-make-node.

Function: api-p (object)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: bf-next (zipper)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: copy-api (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: copy-loc (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: copy-path (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Reader: loc-api (instance)
Writer: (setf loc-api) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

api.

Reader: loc-node (instance)
Writer: (setf loc-node) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

node.

Function: loc-p (object)
Package

cl-zipper.

Source

cl-zipper.lisp.

Reader: loc-path (instance)
Writer: (setf loc-path) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

path.

Function: make-api (&key fn-branch? fn-children fn-make-node)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: make-loc (&key node path api)
Package

cl-zipper.

Source

cl-zipper.lisp.

Function: make-path (&key left path right)
Package

cl-zipper.

Source

cl-zipper.lisp.

Reader: path-left (instance)
Writer: (setf path-left) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

left.

Function: path-p (object)
Package

cl-zipper.

Source

cl-zipper.lisp.

Reader: path-path (instance)
Writer: (setf path-path) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

path.

Reader: path-right (instance)
Writer: (setf path-right) (instance)
Package

cl-zipper.

Source

cl-zipper.lisp.

Target Slot

right.

Function: while (zipper f)
Package

cl-zipper.

Source

util.lisp.


6.2.3 Structures

Structure: api
Package

cl-zipper.

Source

cl-zipper.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: fn-branch?
Readers

api-fn-branch?.

Writers

(setf api-fn-branch?).

Slot: fn-children
Readers

api-fn-children.

Writers

(setf api-fn-children).

Slot: fn-make-node
Readers

api-fn-make-node.

Writers

(setf api-fn-make-node).

Structure: loc
Package

cl-zipper.

Source

cl-zipper.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: node
Readers

loc-node.

Writers

(setf loc-node).

Slot: path
Readers

loc-path.

Writers

(setf loc-path).

Slot: api
Readers

loc-api.

Writers

(setf loc-api).


Appendix A Indexes


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

A.1 Concepts


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?): Private ordinary functions
(setf api-fn-children): Private ordinary functions
(setf api-fn-make-node): Private ordinary functions
(setf loc-api): Private ordinary functions
(setf loc-node): Private ordinary functions
(setf loc-path): Private ordinary functions
(setf path-left): Private ordinary functions
(setf path-path): Private ordinary functions
(setf path-right): Private ordinary functions

-
->: Private macros

A
api-fn-branch?: Private ordinary functions
api-fn-children: Private ordinary functions
api-fn-make-node: Private ordinary functions
api-p: Private ordinary functions
append-child: Public ordinary functions

B
bf-next: Private ordinary functions
branch?: Public ordinary functions

C
children: Public ordinary functions
copy-api: Private ordinary functions
copy-loc: Private ordinary functions
copy-path: Private ordinary functions

D
delete: Public ordinary functions
down: Public ordinary functions

E
edit: Public ordinary functions

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

G
Generic Function, make-zipper: Public generic functions

I
if-let: Private macros
insert-child: Public ordinary functions
insert-left: Public ordinary functions
insert-right: Public ordinary functions

L
left: Public ordinary functions
leftmost: Public ordinary functions
lefts: Public ordinary functions
loc-api: Private ordinary functions
loc-node: Private ordinary functions
loc-p: Private ordinary functions
loc-path: Private ordinary functions

M
Macro, ->: Private macros
Macro, if-let: Private macros
make-api: Private ordinary functions
make-loc: Private ordinary functions
make-node: Public ordinary functions
make-path: Private ordinary functions
make-zipper: Public generic functions
make-zipper: Public generic functions
Method, make-zipper: Public generic functions

N
next: Public ordinary functions
node: Public ordinary functions

P
path: Public ordinary functions
path-left: Private ordinary functions
path-p: Private ordinary functions
path-path: Private ordinary functions
path-right: Private ordinary functions
prev: Public ordinary functions

R
remove: Public ordinary functions
replace: Public ordinary functions
right: Public ordinary functions
rightmost: Public ordinary functions
rights: Public ordinary functions
root: Public ordinary functions

S
splice-left: Public ordinary functions
splice-right: Public ordinary functions

U
up: Public ordinary functions

W
while: Private ordinary functions

Z
zipper: Public ordinary functions

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