The cl-string-complete Reference Manual

This is the cl-string-complete Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:31:51 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-string-complete

Simple string completion in Common Lisp.

Maintainer

Robert Smith

Author

Robert Smith

Long Description

Simple string completion (finding suffixes of a string given a prefix) in Common Lisp.

Version

0.1

Source

cl-string-complete.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-string-complete/cl-string-complete.asd

Source

cl-string-complete.asd.

Parent Component

cl-string-complete (system).

ASDF Systems

cl-string-complete.

Packages

cl-string-complete-asd.


3.1.2 cl-string-complete/package.lisp

Source

cl-string-complete.asd.

Parent Component

cl-string-complete (system).

Packages

cl-string-complete.


3.1.3 cl-string-complete/exact-completion.lisp

Dependency

package.lisp (file).

Source

cl-string-complete.asd.

Parent Component

cl-string-complete (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-string-complete

String completion API.

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 cl-string-complete-asd

Source

cl-string-complete.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: completion-tree-add (tree str)

Add a string STR to the ternary tree TREE.

Package

cl-string-complete.

Source

exact-completion.lisp.

Function: completion-tree-add* (tree &rest strings)

Add a list of strings to TREE. The strings are suffled to help balance the tree.

Package

cl-string-complete.

Source

exact-completion.lisp.

Function: completion-tree-contains-p (tree str)

Check if TREE contains the word STR.

Package

cl-string-complete.

Source

exact-completion.lisp.

Function: completion-tree-p (object)
Package

cl-string-complete.

Source

exact-completion.lisp.

Function: make-completion-tree (&key root)
Package

cl-string-complete.

Source

exact-completion.lisp.


5.1.2 Generic functions

Generic Function: compute-completions (node item &key limit prefixedp)

Compute the completions of of ITEM given a node or
tree NODE. If an integer limit LIMIT is given, then only a maximum of LIMIT completions will be given. If PREFIXEDP is true, then the completions will include the prefix.

Package

cl-string-complete.

Source

exact-completion.lisp.

Methods
Method: compute-completions ((tree completion-tree) item &key limit prefixedp)
Method: compute-completions ((node completion-node) item &key limit prefixedp)

5.1.3 Standalone methods

Method: print-object ((object completion-tree) stream)
Source

exact-completion.lisp.

Method: print-object ((object completion-node) stream)
Source

exact-completion.lisp.


5.1.4 Structures

Structure: completion-tree
Package

cl-string-complete.

Source

exact-completion.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: root
Type

(or null cl-string-complete::completion-node)

Readers

completion-tree.root.

Writers

(setf completion-tree.root).


5.2 Internals


5.2.1 Ordinary functions

Function: completion-node (char)

Make a fresh ternary node. with character CHAR.

Package

cl-string-complete.

Source

exact-completion.lisp.

Function: completion-node-completions (node &key prefix limit)

Walk the children of NODE to find all completions.

Package

cl-string-complete.

Source

exact-completion.lisp.

Function: completion-node-p (object)
Package

cl-string-complete.

Source

exact-completion.lisp.

Function: completion-node-printer (obj stream depth)

Printer for ternary nodes.

Package

cl-string-complete.

Source

exact-completion.lisp.

Reader: completion-node.char (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Target Slot

char.

Reader: completion-node.endp (instance)
Writer: (setf completion-node.endp) (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Target Slot

endp.

Reader: completion-node.left (instance)
Writer: (setf completion-node.left) (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Target Slot

left.

Reader: completion-node.middle (instance)
Writer: (setf completion-node.middle) (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Target Slot

middle.

Reader: completion-node.right (instance)
Writer: (setf completion-node.right) (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Target Slot

right.

Function: completion-tree-printer (obj stream depth)

Printer for ternary trees.

Package

cl-string-complete.

Source

exact-completion.lisp.

Reader: completion-tree.root (instance)
Writer: (setf completion-tree.root) (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Target Slot

root.

Function: copy-completion-node (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Function: copy-completion-tree (instance)
Package

cl-string-complete.

Source

exact-completion.lisp.

Function: make-completion-node (&key char endp left middle right)
Package

cl-string-complete.

Source

exact-completion.lisp.


5.2.2 Generic functions

Generic Function: completion-node-travel (node item)

Travel to the next node from NODE along the branch(es) specified by ITEM.

Package

cl-string-complete.

Source

exact-completion.lisp.

Methods
Method: completion-node-travel ((node completion-node) (item string))
Method: completion-node-travel ((node completion-node) (item list))
Method: completion-node-travel ((node completion-node) (item character))
Method: completion-node-travel ((node null) item)

5.2.3 Structures

Structure: completion-node
Package

cl-string-complete.

Source

exact-completion.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: char
Package

common-lisp.

Type

base-char

Initform

#\nul

Readers

completion-node.char.

Writers

This slot is read-only.

Slot: endp
Package

common-lisp.

Type

boolean

Readers

completion-node.endp.

Writers

(setf completion-node.endp).

Slot: left
Type

(or null cl-string-complete::completion-node)

Readers

completion-node.left.

Writers

(setf completion-node.left).

Slot: middle
Type

(or null cl-string-complete::completion-node)

Readers

completion-node.middle.

Writers

(setf completion-node.middle).

Slot: right
Type

(or null cl-string-complete::completion-node)

Readers

completion-node.right.

Writers

(setf completion-node.right).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   F   G   M   P  
Index Entry  Section

(
(setf completion-node.endp): Private ordinary functions
(setf completion-node.left): Private ordinary functions
(setf completion-node.middle): Private ordinary functions
(setf completion-node.right): Private ordinary functions
(setf completion-tree.root): Private ordinary functions

C
completion-node: Private ordinary functions
completion-node-completions: Private ordinary functions
completion-node-p: Private ordinary functions
completion-node-printer: Private ordinary functions
completion-node-travel: Private generic functions
completion-node-travel: Private generic functions
completion-node-travel: Private generic functions
completion-node-travel: Private generic functions
completion-node-travel: Private generic functions
completion-node.char: Private ordinary functions
completion-node.endp: Private ordinary functions
completion-node.left: Private ordinary functions
completion-node.middle: Private ordinary functions
completion-node.right: Private ordinary functions
completion-tree-add: Public ordinary functions
completion-tree-add*: Public ordinary functions
completion-tree-contains-p: Public ordinary functions
completion-tree-p: Public ordinary functions
completion-tree-printer: Private ordinary functions
completion-tree.root: Private ordinary functions
compute-completions: Public generic functions
compute-completions: Public generic functions
compute-completions: Public generic functions
copy-completion-node: Private ordinary functions
copy-completion-tree: Private ordinary functions

F
Function, (setf completion-node.endp): Private ordinary functions
Function, (setf completion-node.left): Private ordinary functions
Function, (setf completion-node.middle): Private ordinary functions
Function, (setf completion-node.right): Private ordinary functions
Function, (setf completion-tree.root): Private ordinary functions
Function, completion-node: Private ordinary functions
Function, completion-node-completions: Private ordinary functions
Function, completion-node-p: Private ordinary functions
Function, completion-node-printer: Private ordinary functions
Function, completion-node.char: Private ordinary functions
Function, completion-node.endp: Private ordinary functions
Function, completion-node.left: Private ordinary functions
Function, completion-node.middle: Private ordinary functions
Function, completion-node.right: Private ordinary functions
Function, completion-tree-add: Public ordinary functions
Function, completion-tree-add*: Public ordinary functions
Function, completion-tree-contains-p: Public ordinary functions
Function, completion-tree-p: Public ordinary functions
Function, completion-tree-printer: Private ordinary functions
Function, completion-tree.root: Private ordinary functions
Function, copy-completion-node: Private ordinary functions
Function, copy-completion-tree: Private ordinary functions
Function, make-completion-node: Private ordinary functions
Function, make-completion-tree: Public ordinary functions

G
Generic Function, completion-node-travel: Private generic functions
Generic Function, compute-completions: Public generic functions

M
make-completion-node: Private ordinary functions
make-completion-tree: Public ordinary functions
Method, completion-node-travel: Private generic functions
Method, completion-node-travel: Private generic functions
Method, completion-node-travel: Private generic functions
Method, completion-node-travel: Private generic functions
Method, compute-completions: Public generic functions
Method, compute-completions: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods

P
print-object: Public standalone methods
print-object: Public standalone methods