The cl-string-generator Reference Manual

Child Components

package.lisp (file).
constants.lisp (file).
utils.lisp (file).
regex-class.lisp (file).
convert.lisp (file).
generate.lisp (file).

3 Files

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

Lisp

3.1 Lisp

cl-string-generator/cl-string-generator.asd
cl-string-generator/package.lisp
cl-string-generator/constants.lisp
cl-string-generator/utils.lisp
cl-string-generator/regex-class.lisp
cl-string-generator/convert.lisp
cl-string-generator/generate.lisp

3.1.1 `cl-string-generator/cl-string-generator.asd`

Source: cl-string-generator.asd.
Parent Component: cl-string-generator (system).
ASDF Systems: cl-string-generator.

3.1.2 `cl-string-generator/package.lisp`

Source: cl-string-generator.asd.
Parent Component: cl-string-generator (system).
Packages: cl-string-generator.

3.1.3 `cl-string-generator/constants.lisp`

Dependency

package.lisp (file).

Source

Parent Component

cl-string-generator (system).

Internals

+max-repetition+ (special variable).
+string-length-limit+ (special variable).

3.1.4 `cl-string-generator/utils.lisp`

Dependency

constants.lisp (file).

Source

Parent Component

cl-string-generator (system).

Internals

random-char (function).
random-choice (function).
random-digit-char (function).
random-expected-char (function).
random-integer (function).
random-non-digit-char (function).
random-non-whitespace-char (function).
random-non-word-char (function).
random-whitespace-char (function).
random-word-char (function).
string-append (function).
word-char-p (function).

3.1.5 `cl-string-generator/regex-class.lisp`

Dependency

utils.lisp (file).

Source

Parent Component

cl-string-generator (system).

Internals

.choices (reader method).
.function (reader method).
.greedyp (reader method).
.maximum (reader method).
.minimum (reader method).
.number (reader method).
.number (reader method).
.regex (reader method).
.regex (reader method).
.seq (reader method).
.str (reader method).
alternation (class).
back-reference (class).
random-char (class).
regex (class).
register (class).
repetition (class).
seq (class).
str (class).
void (class).

3.1.6 `cl-string-generator/convert.lisp`

Dependency

regex-class.lisp (file).

Source

Parent Component

cl-string-generator (system).

Internals

*register-number* (special variable).
convert (function).
convert-aux (function).
convert-compound-parse-tree (generic function).
convert-sequence (function).
convert-simple-parse-tree (generic function).
random-char-function (function).

3.1.7 `cl-string-generator/generate.lisp`

Dependency

convert.lisp (file).

Source

Parent Component

cl-string-generator (system).

Public Interface

generate (function).

Internals

%generate (function).
*registers* (special variable).
generate-aux (generic function).
generate-using-handler (function).
select (macro).
value (function).
value (condition).
value-of (reader method).

4 Packages

Packages are listed by definition order.

cl-string-generator

4.1 `cl-string-generator`

Source

package.lisp.

Use List

alexandria.
common-lisp.

Public Interface

generate (function).

Internals

%generate (function).
*register-number* (special variable).
*registers* (special variable).
+max-repetition+ (special variable).
+string-length-limit+ (special variable).
.choices (generic reader).
.function (generic reader).
.greedyp (generic reader).
.maximum (generic reader).
.minimum (generic reader).
.number (generic reader).
.regex (generic reader).
.seq (generic reader).
.str (generic reader).
alternation (class).
back-reference (class).
convert (function).
convert-aux (function).
convert-compound-parse-tree (generic function).
convert-sequence (function).
convert-simple-parse-tree (generic function).
generate-aux (generic function).
generate-using-handler (function).
random-char (function).
random-char (class).
random-char-function (function).
random-choice (function).
random-digit-char (function).
random-expected-char (function).
random-integer (function).
random-non-digit-char (function).
random-non-whitespace-char (function).
random-non-word-char (function).
random-whitespace-char (function).
random-word-char (function).
regex (class).
register (class).
repetition (class).
select (macro).
seq (class).
str (class).
string-append (function).
value (function).
value (condition).
value-of (generic reader).
void (class).
word-char-p (function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Ordinary functions

5.1.1 Ordinary functions

Function: generate (regex &key min-length max-length) ¶

Package: cl-string-generator.
Source: generate.lisp.

5.2.1 Special variables

Special Variable: *register-number* ¶

Package: cl-string-generator.
Source: convert.lisp.

Special Variable: *registers* ¶

Package: cl-string-generator.
Source: generate.lisp.

Special Variable: +max-repetition+ ¶

Package: cl-string-generator.
Source: constants.lisp.

Special Variable: +string-length-limit+ ¶

Package: cl-string-generator.
Source: constants.lisp.

5.2.2 Macros

Macro: select ((value form) &body body) ¶

Package: cl-string-generator.
Source: generate.lisp.

5.2.3 Ordinary functions

Function: %generate (regex max-length) ¶

Package: cl-string-generator.
Source: generate.lisp.

Function: convert (regex) ¶

Package: cl-string-generator.
Source: convert.lisp.

Function: convert-aux (parse-tree) ¶

Package: cl-string-generator.
Source: convert.lisp.

Function: convert-sequence (arguments) ¶

Package: cl-string-generator.
Source: convert.lisp.

Function: generate-using-handler (regex max-length function) ¶

Package: cl-string-generator.
Source: generate.lisp.

Function: random-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-char-function (item) ¶

Package: cl-string-generator.
Source: convert.lisp.

Function: random-choice (sequence) ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-digit-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-expected-char (test-function) ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-integer (min max) ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-non-digit-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-non-whitespace-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-non-word-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-whitespace-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: random-word-char () ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: string-append (&rest strings) ¶

Package: cl-string-generator.
Source: utils.lisp.

Function: value (value) ¶

Package: cl-string-generator.
Source: generate.lisp.

Function: word-char-p (c) ¶

Package: cl-string-generator.
Source: utils.lisp.

5.2.4 Generic functions

Generic Reader: .choices (object) ¶

Package

Methods

Reader Method: .choices ((alternation alternation)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: choices.

Generic Reader: .function (object) ¶

Package

Methods

Reader Method: .function ((random-char random-char)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: function.

Generic Reader: .greedyp (object) ¶

Package

Methods

Reader Method: .greedyp ((repetition repetition)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: greedyp.

Generic Reader: .maximum (object) ¶

Package

Methods

Reader Method: .maximum ((repetition repetition)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: maximum.

Generic Reader: .minimum (object) ¶

Package

Methods

Reader Method: .minimum ((repetition repetition)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: minimum.

Generic Reader: .number (object) ¶

Package

Methods

Reader Method: .number ((back-reference back-reference)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: number.

Reader Method: .number ((register register)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: number.

Generic Reader: .regex (object) ¶

Package

Methods

Reader Method: .regex ((register register)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: regex.

Reader Method: .regex ((repetition repetition)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: regex.

Generic Reader: .seq (object) ¶

Package

Methods

Reader Method: .seq ((seq seq)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: seq.

Generic Reader: .str (object) ¶

Package

Methods

Reader Method: .str ((str str)) ¶

automatically generated reader method

Source: regex-class.lisp.
Target Slot: str.

Generic Function: convert-compound-parse-tree (token parse-tree) ¶

Package

Source

convert.lisp.

Methods

Method: convert-compound-parse-tree ((token (eql :sequence)) parse-tree) ¶

Method: convert-compound-parse-tree ((token (eql :alternation)) parse-tree) ¶

Method: convert-compound-parse-tree ((token (eql :group)) parse-tree) ¶

Method: convert-compound-parse-tree ((token (eql :char-class)) parse-tree) ¶

Method: convert-compound-parse-tree ((token (eql :greedy-repetition)) parse-tree) ¶

Method: convert-compound-parse-tree ((token (eql :register)) parse-tree) ¶

Method: convert-compound-parse-tree ((token (eql :back-reference)) parse-tree) ¶

Generic Function: convert-simple-parse-tree (parse-tree) ¶

Package

Source

convert.lisp.

Methods

Method: convert-simple-parse-tree ((parse-tree character)) ¶

Method: convert-simple-parse-tree ((parse-tree string)) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :void))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :word-boundary))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :non-word-boundary))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :everything))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :digit-class))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :word-char-class))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :whitespace-char-class))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :non-digit-class))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :non-word-char-class))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :non-whitespace-char-class))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :start-anchor))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :end-anchor))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :modeless-start-anchor))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :modeless-end-anchor))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :modeless-end-anchor-no-newline))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :case-insensitive-p))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :case-sensitive-p))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :multi-line-mode-p))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :not-multi-line-mode-p))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :single-line-mode-p))) ¶

Method: convert-simple-parse-tree ((parse-tree (eql :not-single-line-mode-p))) ¶

Generic Function: generate-aux (regex rest-length) ¶

Package

Source

generate.lisp.

Methods

Method: generate-aux ((regex random-char) rest-length) ¶

Method: generate-aux ((regex back-reference) rest-length) ¶

Method: generate-aux ((regex register) rest-length) ¶

Method: generate-aux ((regex repetition) rest-length) ¶

Method: generate-aux ((regex alternation) rest-length) ¶

Method: generate-aux ((regex seq) rest-length) ¶

Method: generate-aux ((regex str) rest-length) ¶

Method: generate-aux ((regex void) rest-length) ¶

Method: generate-aux ((regex null) rest-length) ¶

Generic Reader: value-of (condition) ¶

Package

Methods

Reader Method: value-of ((condition value)) ¶

Source: generate.lisp.
Target Slot: value.

5.2.5 Conditions

Condition: value ¶

Package

Source

generate.lisp.

Direct superclasses

condition.

Direct methods

value-of.

Direct slots

Slot: value ¶

Initargs: :value
Readers: value-of.
Writers: This slot is read-only.

5.2.6 Classes

Class: alternation ¶

Package

Source

Direct superclasses

Direct methods

.choices.
generate-aux.

Direct slots

Slot: choices ¶

Initargs: :choices
Readers: .choices.
Writers: This slot is read-only.

Class: back-reference ¶

Package

Source

Direct superclasses

Direct methods

.number.
generate-aux.

Direct slots

Slot: number ¶

Package: common-lisp.
Initargs: :number
Readers: .number.
Writers: This slot is read-only.

Class: random-char ¶

Package

Source

Direct superclasses

Direct methods

.function.
generate-aux.

Direct slots

Slot: function ¶

Package: common-lisp.
Initargs: :function
Readers: .function.
Writers: This slot is read-only.

Class: regex ¶

Package

Source

Direct subclasses

alternation.
back-reference.
random-char.
register.
repetition.
seq.
str.
void.

Class: register ¶

Package

Source

Direct superclasses

Direct methods

.number.
.regex.
generate-aux.

Direct slots

Slot: regex ¶

Initargs: :regex
Readers: .regex.
Writers: This slot is read-only.

Slot: number ¶

Package: common-lisp.
Initargs: :number
Readers: .number.
Writers: This slot is read-only.

Class: repetition ¶

Package

Source

Direct superclasses

Direct methods

.greedyp.
.maximum.
.minimum.
.regex.
generate-aux.

Direct slots

Slot: regex ¶

Initargs: :regex
Readers: .regex.
Writers: This slot is read-only.

Slot: greedyp ¶

Initargs: :greedyp
Readers: .greedyp.
Writers: This slot is read-only.

Slot: minimum ¶

Initargs: :minimum
Readers: .minimum.
Writers: This slot is read-only.

Slot: maximum ¶

Initargs: :maximum
Readers: .maximum.
Writers: This slot is read-only.

Class: seq ¶

Package

Source

Direct superclasses

Direct methods

.seq.
generate-aux.

Direct slots

Slot: seq ¶

Initargs: :seq
Readers: .seq.
Writers: This slot is read-only.

Class: str ¶

Package

Source

Direct superclasses