The flx Reference Manual

This is the flx Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:54:22 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 flx

Rewrite emacs-flx in Common Lisp

Author

Jen-Chieh Shen

License

MIT

Version

0.1.0

Source

flx.asd.

Child Component

flx.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 flx/flx.asd

Source

flx.asd.

Parent Component

flx (system).

ASDF Systems

flx.


3.1.2 flx/flx.lisp

Source

flx.asd.

Parent Component

flx (system).

Packages

flx.

Public Interface

score (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 flx

Source

flx.lisp.

Use List

common-lisp.

Public Interface

score (function).

Internals

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: score (str query &optional cache)

Return best score matching QUERY against STR.

Package

flx.

Source

flx.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: word-separators

List of characters that act as word separators in flx.

Package

flx.

Source

flx.lisp.


5.2.2 Ordinary functions

Function: bigger-sublist (sorted-list val)

Return sublist bigger than VAL from sorted SORTED-LIST.

If VAL is nil, return entire list.

Package

flx.

Source

flx.lisp.

Function: boundary-p (last-char char)

Check if LAST-CHAR is the end of a word and CHAR the start of the next.

This function is camel-case aware.

Package

flx.

Source

flx.lisp.

Function: capital-p (char)

Check if CHAR is an uppercase character.

Package

flx.

Source

flx.lisp.

Function: find-best-match (str-info heatmap greater-than query query-length q-index match-cache)

Recursively compute the best match for a string, passed as STR-INFO and HEATMAP, according to QUERY.

This function uses MATCH-CACHE to memoize its return values.
For other parameters, see ‘score’

Package

flx.

Source

flx.lisp.

Function: get-hash-for-string (str heatmap-func)

Return hash-table for string where keys are characters.

Value is a sorted list of indexes for character occurrences.

Package

flx.

Source

flx.lisp.

Function: get-heatmap-str (str &optional group-separator)

Generate the heatmap vector of string.

See documentation for logic.

Package

flx.

Source

flx.lisp.

Function: inc-vec (vec &optional inc beg end)

Increment each element in VEC between BEG and END by INC.

INC defaults to 1. BEG defaults to 0 and is inclusive. END is not inclusive and defaults to the length of VEC.

Package

flx.

Source

flx.lisp.

Function: memq (elt list)

Mimic ‘memq’ function.

Package

flx.

Source

flx.lisp.

Function: process-cache (str cache)

Get calculated heatmap from cache, add it if necessary.

Package

flx.

Source

flx.lisp.

Function: word-p (char)

Check if CHAR is a word character.

Package

flx.

Source

flx.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   S   W  
Index Entry  Section

S
Special Variable, word-separators: Private special variables

W
word-separators: Private special variables