The cl-acronyms Reference Manual

This is the cl-acronyms Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 04:33:25 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-acronyms

A program that expands an acronym based on grammatical rules.

Maintainer

Isoraķatheð Zorethan <>

Author

Isoraķatheð Zorethan <>

License

MIT

Version

1.0.0

Dependencies
  • alexandria (system).
  • split-sequence (system).
Source

cl-acronyms.asd.

Child Component

cl-acronyms.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-acronyms/cl-acronyms.asd

Source

cl-acronyms.asd.

Parent Component

cl-acronyms (system).

ASDF Systems

cl-acronyms.

Packages

info.isoraqathedh.cl-acronyms.asdf.


3.1.2 cl-acronyms/cl-acronyms.lisp

Source

cl-acronyms.asd.

Parent Component

cl-acronyms (system).

Packages

info.isoraqathedh.cl-acronyms.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 info.isoraqathedh.cl-acronyms.asdf

Source

cl-acronyms.asd.

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

4.2 info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp.

Nickname

cl-acronyms

Use List
  • common-lisp.
  • split-sequence.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *master-structures-list*

The vector that holds all structures.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Special Variable: *master-word-list*

The word list holding all words and their parts of speech.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Special Variable: *word-list-file-location*

Location of which the list of words with part of speech modifiers are located.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.


5.1.2 Ordinary functions

Function: expand (acronym &optional times)

Expands an acronym. If ’times’ is provided, repeats expansion that many times and collects results into a list.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: refresh-list ()

Reloads the list from mobiposi.i, replacing all entries orginally in *master-word-list*. Returns the number of items placed into the word bank.
Skips any entries that have spaces.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: refresh-structures ()

Resets the structure list to the value seen at the structures.lisp file.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: reset-list ()

Delete all entries from *master-word-list*. Returns t on success.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: total-entries ()

Returns the total length the dictionary.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: total-structures ()

Returns the total number of structures.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *report-stream*

Certain functions will print a progress bar in reading files. This is where it is printed to.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Special Variable: *structures-file-location*

Location of which the list of structures is located.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Special Variable: *word-count-array*

An array counting the number of words satisfying a given first letter and a given part of speech.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.


5.2.2 Ordinary functions

Function: %expand (acronym)

Main acronym expansion logic.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: %read-structures ()

Reads the structures from structures.lisp.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: %reset-list ()

Blank list for *master-word-list*

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: decode-pos-letter (letter)

Turns the codes used by mobiposi.i into keywords corresponding to keys in the hash table.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: generate-word (start-letter)

Generates a (nonsensical) word that starts with the given letter.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: get-dictionary-length (pos-letter start-letter)

Returns how many words there are in the word.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: get-pos-template (acronym)

Returns an appropriate part-of-speech template for a given acronym, ready for use in build-backronym.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: letter-associate-number (letter)

Turns A = 0, B = 1, ..., Z = 25

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: letterp (thing)
Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: pos-associate-number (letter)

Turns the codes used by mobiposi.i into keywords corresponding to keys in the hash table.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.

Function: random-word (part-of-speech &optional letter)

Grabs a random word starting with the given part of speech starting with letter, if given. If part-of-speech is supplied as a word, then that word is used, discarding letter. [This is so to facilitate build-acronym].
If a letter is supplied, will only supply words that start with that letter;
if no such word exists, then a nonce word is generated instead.

Package

info.isoraqathedh.cl-acronyms.

Source

cl-acronyms.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
D   E   F   G   L   P   R   T  
Index Entry  Section

%
%expand: Private ordinary functions
%read-structures: Private ordinary functions
%reset-list: Private ordinary functions

D
decode-pos-letter: Private ordinary functions

E
expand: Public ordinary functions

F
Function, %expand: Private ordinary functions
Function, %read-structures: Private ordinary functions
Function, %reset-list: Private ordinary functions
Function, decode-pos-letter: Private ordinary functions
Function, expand: Public ordinary functions
Function, generate-word: Private ordinary functions
Function, get-dictionary-length: Private ordinary functions
Function, get-pos-template: Private ordinary functions
Function, letter-associate-number: Private ordinary functions
Function, letterp: Private ordinary functions
Function, pos-associate-number: Private ordinary functions
Function, random-word: Private ordinary functions
Function, refresh-list: Public ordinary functions
Function, refresh-structures: Public ordinary functions
Function, reset-list: Public ordinary functions
Function, total-entries: Public ordinary functions
Function, total-structures: Public ordinary functions

G
generate-word: Private ordinary functions
get-dictionary-length: Private ordinary functions
get-pos-template: Private ordinary functions

L
letter-associate-number: Private ordinary functions
letterp: Private ordinary functions

P
pos-associate-number: Private ordinary functions

R
random-word: Private ordinary functions
refresh-list: Public ordinary functions
refresh-structures: Public ordinary functions
reset-list: Public ordinary functions

T
total-entries: Public ordinary functions
total-structures: Public ordinary functions