The cl-string-generator Reference Manual

Table of Contents

The cl-string-generator Reference Manual

This is the cl-string-generator Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:37:10 2020 GMT+0.

1 Introduction

cl-string-generator

Generate string from regular expression

Usage

(ql:quickload :cl-string-generator)
(use-package :cl-string-generator)

(generate "[0-9A-F]{8}-(?:[0-9A-F]{4}-){3}[0-9A-F]{8}")
;; => "A64BE7F3-1041-6C90-D8EB-2A0F46A8"

(generate "(foo|bar)\\1")
;; => "foofoo"

(generate "a*b*" :max-length 3)
;; => "aab"

(generate "a*b*" :min-length 3 :max-length 4)
;; => "aaab"

License

MIT

2 Systems

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

2.1 cl-string-generator

Author

Pocket Change

License

MIT

Description

Generate string from regular expression

Dependencies

• alexandria
• cl-ppcre

Source

cl-string-generator.asd (file)

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.

3.1 Lisp

3.1.1 cl-string-generator.asd

Location

cl-string-generator.asd

Systems

cl-string-generator (system)

3.1.2 cl-string-generator/package.lisp

Parent

cl-string-generator (system)

Location

package.lisp

Packages

cl-string-generator

3.1.3 cl-string-generator/constants.lisp

Dependency

package.lisp (file)

Parent

cl-string-generator (system)

Location

constants.lisp

Internal Definitions

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

3.1.4 cl-string-generator/utils.lisp

Dependency

constants.lisp (file)

Parent

cl-string-generator (system)

Location

utils.lisp

Internal Definitions

• 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)

Parent

cl-string-generator (system)

Location

regex-class.lisp

Internal Definitions

• .choices (method)
• .function (method)
• .greedyp (method)
• .maximum (method)
• .minimum (method)
• .number (method)
• .number (method)
• .regex (method)
• .regex (method)
• .seq (method)
• .str (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)

Parent

cl-string-generator (system)

Location

convert.lisp

Internal Definitions

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

3.1.7 cl-string-generator/generate.lisp

Dependency

convert.lisp (file)

Parent

cl-string-generator (system)

Location

generate.lisp

Exported Definitions

generate (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 cl-string-generator

Source

package.lisp (file)

Use List

• alexandria
• common-lisp

Exported Definitions

generate (function)

Internal Definitions

• %generate (function)
• *register-number* (special variable)
• *registers* (special variable)
• +max-repetition+ (special variable)
• +string-length-limit+ (special variable)
• .choices (generic function)
• .choices (method)
• .function (generic function)
• .function (method)
• .greedyp (generic function)
• .greedyp (method)
• .maximum (generic function)
• .maximum (method)
• .minimum (generic function)
• .minimum (method)
• .number (generic function)
• .number (method)
• .number (method)
• .regex (generic function)
• .regex (method)
• .regex (method)
• .seq (generic function)
• .seq (method)
• .str (generic function)
• .str (method)
• alternation (class)
• back-reference (class)
• convert (function)
• convert-aux (function)
• convert-compound-parse-tree (generic function)
• convert-compound-parse-tree (method)
• convert-compound-parse-tree (method)
• convert-compound-parse-tree (method)
• convert-compound-parse-tree (method)
• convert-compound-parse-tree (method)
• convert-compound-parse-tree (method)
• convert-compound-parse-tree (method)
• convert-sequence (function)
• convert-simple-parse-tree (generic function)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• convert-simple-parse-tree (method)
• generate-aux (generic function)
• generate-aux (method)
• generate-aux (method)
• generate-aux (method)
• generate-aux (method)
• generate-aux (method)
• generate-aux (method)
• generate-aux (method)
• generate-aux (method)
• 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 function)
• value-of (method)
• void (class)
• word-char-p (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: generate REGEX &key MIN-LENGTH MAX-LENGTH

Package

cl-string-generator

Source

generate.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *register-number*

Package

cl-string-generator

Source

convert.lisp (file)

Special Variable: *registers*

Package

cl-string-generator

Source

generate.lisp (file)

Special Variable: +max-repetition+

Package

cl-string-generator

Source

constants.lisp (file)

Special Variable: +string-length-limit+

Package

cl-string-generator

Source

constants.lisp (file)

5.2.2 Macros

Macro: select (VALUE FORM) &body BODY

Package

cl-string-generator

Source

generate.lisp (file)

5.2.3 Functions

Function: %generate REGEX MAX-LENGTH

Package

cl-string-generator

Source

generate.lisp (file)

Function: convert REGEX

Package

cl-string-generator

Source

convert.lisp (file)

Function: convert-aux PARSE-TREE

Package

cl-string-generator

Source

convert.lisp (file)

Function: convert-sequence ARGUMENTS

Package

cl-string-generator

Source

convert.lisp (file)

Function: generate-using-handler REGEX MAX-LENGTH FUNCTION

Package

cl-string-generator

Source

generate.lisp (file)

Function: random-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-char-function ITEM

Package

cl-string-generator

Source

convert.lisp (file)

Function: random-choice SEQUENCE

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-digit-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-expected-char TEST-FUNCTION

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-integer MIN MAX

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-non-digit-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-non-whitespace-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-non-word-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-whitespace-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: random-word-char ()

Package

cl-string-generator

Source

utils.lisp (file)

Function: string-append &rest STRINGS

Package

cl-string-generator

Source

utils.lisp (file)

Function: value VALUE

Package

cl-string-generator

Source

generate.lisp (file)

Function: word-char-p C

Package

cl-string-generator

Source

utils.lisp (file)

5.2.4 Generic functions

Generic Function: .choices OBJECT

Package

cl-string-generator

Methods

Method: .choices (ALTERNATION alternation)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .function OBJECT

Package

cl-string-generator

Methods

Method: .function (RANDOM-CHAR random-char)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .greedyp OBJECT

Package

cl-string-generator

Methods

Method: .greedyp (REPETITION repetition)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .maximum OBJECT

Package

cl-string-generator

Methods

Method: .maximum (REPETITION repetition)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .minimum OBJECT

Package

cl-string-generator

Methods

Method: .minimum (REPETITION repetition)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .number OBJECT

Package

cl-string-generator

Methods

Method: .number (BACK-REFERENCE back-reference)

automatically generated reader method

Source

regex-class.lisp (file)

Method: .number (REGISTER register)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .regex OBJECT

Package

cl-string-generator

Methods

Method: .regex (REGISTER register)

automatically generated reader method

Source

regex-class.lisp (file)

Method: .regex (REPETITION repetition)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .seq OBJECT

Package

cl-string-generator

Methods

Method: .seq (SEQ seq)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: .str OBJECT

Package

cl-string-generator

Methods

Method: .str (STR str)

automatically generated reader method

Source

regex-class.lisp (file)

Generic Function: convert-compound-parse-tree TOKEN PARSE-TREE

Package

cl-string-generator

Source

convert.lisp (file)

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

cl-string-generator

Source

convert.lisp (file)

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

cl-string-generator

Source

generate.lisp (file)

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

Generic Function: value-of CONDITION

Package

cl-string-generator

Methods

Method: value-of (CONDITION value)

Source

generate.lisp (file)

5.2.5 Conditions

Condition: value ()

Package

cl-string-generator

Source

generate.lisp (file)

Direct superclasses

condition (condition)

Direct methods

value-of (method)

Direct slots

Slot: value

Initargs

:value

Readers

value-of (generic function)

5.2.6 Classes

Class: alternation ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .choices (method)

Direct slots

Slot: choices

Initargs

:choices

Readers

.choices (generic function)

Class: back-reference ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .number (method)

Direct slots

Slot: number

Initargs

:number

Readers

.number (generic function)

Class: random-char ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .function (method)

Direct slots

Slot: function

Initargs

:function

Readers

.function (generic function)

Class: regex ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• void (class)
• str (class)
• seq (class)
• alternation (class)
• repetition (class)
• register (class)
• back-reference (class)
• random-char (class)

Class: register ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .number (method)
• .regex (method)

Direct slots

Slot: regex

Initargs

:regex

Readers

.regex (generic function)

Slot: number

Initargs

:number

Readers

.number (generic function)

Class: repetition ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .maximum (method)
• .minimum (method)
• .greedyp (method)
• .regex (method)

Direct slots

Slot: regex

Initargs

:regex

Readers

.regex (generic function)

Slot: greedyp

Initargs

:greedyp

Readers

.greedyp (generic function)

Slot: minimum

Initargs

:minimum

Readers

.minimum (generic function)

Slot: maximum

Initargs

:maximum

Readers

.maximum (generic function)

Class: seq ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .seq (method)

Direct slots

Slot: seq

Initargs

:seq

Readers

.seq (generic function)

Class: str ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

• generate-aux (method)
• .str (method)

Direct slots

Slot: str

Initargs

:str

Readers

.str (generic function)

Class: void ()

Package

cl-string-generator

Source

regex-class.lisp (file)

Direct superclasses

regex (class)

Direct methods

generate-aux (method)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types