The cl-string-complete Reference Manual

Table of Contents

The cl-string-complete Reference Manual

This is the cl-string-complete Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:22:56 2021 GMT+0.

1 Introduction

#+TITLE: The =CL-STRING-COMPLETE= String Completion Library
#+AUTHOR: Robert Smith
#+EMAIL: quad@symbo1ics.com

* Summary
A small library for string completion by Robert Smith.

* Usage
The principle use follows.

Create a completion tree:

    : > (defparameter *tree* (make-completion-tree))

Add your words to it:

    : > (completion-tree-add *tree* "hello")
    : > (completion-tree-add* *tree* "helmet"
    :                                "help"
    :                                "helsinki")

Check if something exists in the tree:

    : > (completion-tree-contains-p *tree* "hello")
    : T
    : > (completion-tree-contains-p *tree* "hexagon")
    : NIL

Compute the completions of a character:

    : > (compute-completions *tree* #\h)
    : ("ello" "elmet" "elp" "elsinki")
    : > (compute-completions *tree* #\x)
    : NIL

Compute the completions of a string:

    : > (compute-completions *tree* "hel")
    : ("lo" "met" "sinki" "p")

* Dependencies
None.

* License
See the file ~LICENSE~.

----------
### End of file

2 Systems

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

2.1 cl-string-complete

Maintainer

Robert Smith

Author

Robert Smith

Description

Simple string completion in Common Lisp.

Long Description

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

Version

0.1

Source

cl-string-complete.asd (file)

Components

• package.lisp (file)
• exact-completion.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 cl-string-complete.asd

Location

cl-string-complete.asd

Systems

cl-string-complete (system)

Packages

cl-string-complete-asd

3.1.2 cl-string-complete/package.lisp

Parent

cl-string-complete (system)

Location

package.lisp

Packages

cl-string-complete

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

Dependency

package.lisp (file)

Parent

cl-string-complete (system)

Location

exact-completion.lisp

Exported Definitions

• completion-tree (structure)
• completion-tree-add (function)
• completion-tree-add* (function)
• completion-tree-contains-p (function)
• completion-tree-p (function)
• compute-completions (generic function)
• compute-completions (method)
• compute-completions (method)
• make-completion-tree (function)

Internal Definitions

• completion-node (function)
• completion-node (structure)
• completion-node-completions (function)
• completion-node-p (function)
• completion-node-printer (function)
• completion-node-travel (generic function)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node.char (function)
• completion-node.endp (function)
• (setf completion-node.endp) (function)
• completion-node.left (function)
• (setf completion-node.left) (function)
• completion-node.middle (function)
• (setf completion-node.middle) (function)
• completion-node.right (function)
• (setf completion-node.right) (function)
• completion-tree-printer (function)
• completion-tree.root (function)
• (setf completion-tree.root) (function)
• copy-completion-node (function)
• copy-completion-tree (function)
• make-completion-node (function)

4 Packages

Packages are listed by definition order.

4.1 cl-string-complete-asd

Source

cl-string-complete.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-string-complete

String completion API.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• completion-tree (structure)
• completion-tree-add (function)
• completion-tree-add* (function)
• completion-tree-contains-p (function)
• completion-tree-p (function)
• compute-completions (generic function)
• compute-completions (method)
• compute-completions (method)
• make-completion-tree (function)

Internal Definitions

• completion-node (function)
• completion-node (structure)
• completion-node-completions (function)
• completion-node-p (function)
• completion-node-printer (function)
• completion-node-travel (generic function)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node.char (function)
• completion-node.endp (function)
• (setf completion-node.endp) (function)
• completion-node.left (function)
• (setf completion-node.left) (function)
• completion-node.middle (function)
• (setf completion-node.middle) (function)
• completion-node.right (function)
• (setf completion-node.right) (function)
• completion-tree-printer (function)
• completion-tree.root (function)
• (setf completion-tree.root) (function)
• copy-completion-node (function)
• copy-completion-tree (function)
• make-completion-node (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: completion-tree-add ()

Add a string STR to the ternary tree TREE.

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-tree-add* ()

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

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-tree-contains-p ()

Check if TREE contains the word STR.

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-tree-p ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: make-completion-tree ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

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 (file)

Methods

Method: compute-completions (TREE completion-tree) ITEM &key LIMIT PREFIXEDP

Method: compute-completions (NODE completion-node) ITEM &key LIMIT PREFIXEDP

5.1.3 Structures

Structure: completion-tree ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• compute-completions (method)
• print-object (method)

Direct slots

Slot: root

Type

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

Readers

completion-tree.root (function)

Writers

(setf completion-tree.root) (function)

5.2 Internal definitions

5.2.1 Functions

Function: completion-node ()

Make a fresh ternary node. with character CHAR.

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node-completions ()

Walk the children of NODE to find all completions.

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node-p ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node-printer ()

Printer for ternary nodes.

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node.char ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node.endp ()

Function: (setf completion-node.endp) ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node.left ()

Function: (setf completion-node.left) ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node.middle ()

Function: (setf completion-node.middle) ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-node.right ()

Function: (setf completion-node.right) ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-tree-printer ()

Printer for ternary trees.

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: completion-tree.root ()

Function: (setf completion-tree.root) ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: copy-completion-node ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: copy-completion-tree ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

Function: make-completion-node ()

Package

cl-string-complete

Source

exact-completion.lisp (file)

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 (file)

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 (file)

Direct superclasses

structure-object (structure)

Direct methods

• compute-completions (method)
• completion-node-travel (method)
• completion-node-travel (method)
• completion-node-travel (method)
• print-object (method)

Direct slots

Slot: char

Type

base-char

Initform

#\nul

Readers

completion-node.char (function)

Writers

(setf completion-node.char) (function)

Slot: endp

Type

boolean

Readers

completion-node.endp (function)

Writers

(setf completion-node.endp) (function)

Slot: left

Type

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

Readers

completion-node.left (function)

Writers

(setf completion-node.left) (function)

Slot: middle

Type

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

Readers

completion-node.middle (function)

Writers

(setf completion-node.middle) (function)

Slot: right

Type

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

Readers

completion-node.right (function)

Writers

(setf completion-node.right) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types