The textery Reference Manual

Table of Contents

The textery Reference Manual

This is the textery Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 13:06:32 2020 GMT+0.

1 Introduction

textery

ava fox

implementation of tracery in lisp

Installation

$ git clone https://github.com/compufox/textery ~/common-lisp/textery
* (ql:quickload :textery)

Usage

Load a rule file (a normal tracery JSON file) using (load-grammar "rule.file")

If this is the first rule file loaded, it is set as the current grammar.

To expand text, use (expand "#expand# this!")

If you have multiple grammars loaded use the (with-grammar) macro to select which grammar to use:

(with-grammar "grammar2"
  (expand "#test#"))

You can pass arguments to the text to be expanded by using periods: (expand-text "#test.string-upcase#"), these can be chained together by doing (expand-text "#test.string-upcase.reverse#")

Arguments are any lisp function that can handle at least one string parameter. You can even provide your own!

If you want to use functions that require more than one parameter do as follows:

(defun example-argument (text param param2)
  (concatenate 'string
			   text
			   param
			   param2))

(expand "#test.example-argument(5,test)#")

API

(load-grammar file)

loads grammar from FILE

stores the contents internally under the FILE's name minus the extension

if this is the first grammar thats loaded, set our current grammar to it

(load-grammar-directory dir)

loads all grammars from directory DIR

(create-grammar name grammar)

manually creates a grammar using NAME and GRAMMAR

GRAMMAR is a tracery-formatted json string

(with-grammar grammar &body body)

executes BODY with GRAMMAR set to be the current grammar

GRAMMAR is the filename (minus extension) of the grammar file previous loaded

(list-grammars)

returns a list of all loaded grammars

(expand text)

expands TEXT using the current grammar

License

BSD 3-Clause

2 Systems

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

2.1 textery

Author

ava fox

License

BSD 3-Clause

Description

tracery lisp implementation

Version

0.2

Dependencies

• str
• cl-json
• uiop
• cl-ppcre

Source

textery.asd (file)

Components

• package.lisp (file)
• util.lisp (file)
• eng-modifiers.lisp (file)
• textery.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 textery.asd

Location

textery.asd

Systems

textery (system)

3.1.2 textery/package.lisp

Parent

textery (system)

Location

package.lisp

Packages

textery

3.1.3 textery/util.lisp

Dependency

package.lisp (file)

Parent

textery (system)

Location

util.lisp

Internal Definitions

• agetf (function)
• apply-arguments (function)
• c= (function)
• get-all-actions (function)
• get-all-symbols (function)
• json-string-to-symbol (function)
• last-letter (function)
• parse-function (function)
• random-from-list (function)
• replace-first (function)
• vowel-p (function)

3.1.4 textery/eng-modifiers.lisp

Dependency

util.lisp (file)

Parent

textery (system)

Location

eng-modifiers.lisp

Internal Definitions

• a (function)
• ed (function)
• possesive (function)
• s (function)

3.1.5 textery/textery.lisp

Dependency

eng-modifiers.lisp (file)

Parent

textery (system)

Location

textery.lisp

Exported Definitions

• create-grammar (function)
• expand (function)
• load-grammar (function)
• load-grammar-directory (function)
• with-grammar (macro)

Internal Definitions

• *action-rules* (special variable)
• *current-grammar* (special variable)
• *grammars* (special variable)
• grammar-value (function)
• list-grammars (function)
• process-actions (function)
• process-symbols (function)

4 Packages

Packages are listed by definition order.

4.1 textery

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• create-grammar (function)
• expand (function)
• load-grammar (function)
• load-grammar-directory (function)
• with-grammar (macro)

Internal Definitions

• *action-rules* (special variable)
• *current-grammar* (special variable)
• *grammars* (special variable)
• a (function)
• agetf (function)
• apply-arguments (function)
• c= (function)
• ed (function)
• get-all-actions (function)
• get-all-symbols (function)
• grammar-value (function)
• json-string-to-symbol (function)
• last-letter (function)
• list-grammars (function)
• parse-function (function)
• possesive (function)
• process-actions (function)
• process-symbols (function)
• random-from-list (function)
• replace-first (function)
• s (function)
• vowel-p (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-grammar GRAMMAR &body BODY

executes BODY with current-grammar set to GRAMMAR

Package

textery

Source

textery.lisp (file)

5.1.2 Functions

Function: create-grammar NAME GRAMMAR

creates a grammar from a string

NAME is a string that denotes what the grammar is to be called GRAMMAR is a string that contains tracery formatted json

Package

textery

Source

textery.lisp (file)

Function: expand TEXT

expands TEXT

Package

textery

Source

textery.lisp (file)

Function: load-grammar FILE

loads the json grammar referred to by FILE

Package

textery

Source

textery.lisp (file)

Function: load-grammar-directory DIR

loads all grammars from directory DIR

Package

textery

Source

textery.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *action-rules*

rules added by actions
very volatile, only used during evaluations

Package

textery

Source

textery.lisp (file)

Special Variable: *current-grammar*

current grammar being used

Package

textery

Source

textery.lisp (file)

Special Variable: *grammars*

all currently loaded grammar files

Package

textery

Source

textery.lisp (file)

5.2.2 Functions

Function: a WORD

puts ’a’ or ’an’ in front of WORD

Package

textery

Source

eng-modifiers.lisp (file)

Function: agetf PLACE INDICATOR &optional DEFAULT

getf but for alists

Package

textery

Source

util.lisp (file)

Function: apply-arguments TEXT ARGUMENTS

applies all ARGUMENTS to TEXT

ARGUMENTS is a list of strings that refer to lisp functions

Package

textery

Source

util.lisp (file)

Function: c= CHAR &rest COMPARE

returns non-nil if CHAR is one of COMPARE characters

Package

textery

Source

util.lisp (file)

Function: ed WORD

naively applies ’ed’ to the end of WORD

Package

textery

Source

eng-modifiers.lisp (file)

Function: get-all-actions TEXT

retrieves all actions from TEXT

Package

textery

Source

util.lisp (file)

Function: get-all-symbols TEXT

retrieves all symbols from TEXT

Package

textery

Source

util.lisp (file)

Function: grammar-value KEY

returns a value from the current grammar using KEY

Package

textery

Source

textery.lisp (file)

Function: json-string-to-symbol JSON-STRING &key AS-STRING AS-KEYWORD

converts camelCase JSON-STRING to a symbol

if AS-STRING is non-nil, returns a string instead of a symbol if AS-KEYWORD is non-nil, returns a keyword

Package

textery

Source

util.lisp (file)

Function: last-letter WORD

gets last letter of WORD

Package

textery

Source

util.lisp (file)

Function: list-grammars ()

returns a list of loaded grammars

Package

textery

Source

textery.lisp (file)

Function: parse-function NAME

returns a function of name NAME

Package

textery

Source

util.lisp (file)

Function: possesive WORD

naively converts WORD into its possesive form

Package

textery

Source

eng-modifiers.lisp (file)

Function: process-actions ACTIONS TEXT

processes all ACTIONS, removing them from TEXT

Package

textery

Source

textery.lisp (file)

Function: process-symbols SYMBOLS TEXT

processes all SYMBOLS, evaluating and replacing them in TEXT

Package

textery

Source

textery.lisp (file)

Function: random-from-list LST

returns a random element from LST

Package

textery

Source

util.lisp (file)

Function: replace-first OLD NEW S

replaces the first occurance of OLD with NEW in S

if OLD isn’t found in S, returns S as-is

Package

textery

Source

util.lisp (file)

Function: s WORD

naively pluralizes WORD

Package

textery

Source

eng-modifiers.lisp (file)

Function: vowel-p CHAR

returns non-nil is CHAR is a vowel

Package

textery

Source

util.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types