The cl-string-generator Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-string-generator Reference Manual

This is the cl-string-generator Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:10:31 2022 GMT+0.

Table of Contents


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.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-string-generator

Generate string from regular expression

Author

Pocket Change

License

MIT

Dependencies
  • alexandria (system).
  • cl-ppcre (system).
Source

cl-string-generator.asd.

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 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

cl-string-generator.asd.

Parent Component

cl-string-generator (system).

Internals

3.1.4 cl-string-generator/utils.lisp

Dependency

constants.lisp (file).

Source

cl-string-generator.asd.

Parent Component

cl-string-generator (system).

Internals

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

Dependency

utils.lisp (file).

Source

cl-string-generator.asd.

Parent Component

cl-string-generator (system).

Internals

3.1.6 cl-string-generator/convert.lisp

Dependency

regex-class.lisp (file).

Source

cl-string-generator.asd.

Parent Component

cl-string-generator (system).

Internals

3.1.7 cl-string-generator/generate.lisp

Dependency

convert.lisp (file).

Source

cl-string-generator.asd.

Parent Component

cl-string-generator (system).

Public Interface

generate (function).

Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-string-generator

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface

generate (function).

Internals

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

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

cl-string-generator.

Source

generate.lisp.


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

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.


Next: , Previous: , Up: Internals   [Contents][Index]

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.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.4 Generic functions

Generic Reader: .choices (object)
Package

cl-string-generator.

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

automatically generated reader method

Source

regex-class.lisp.

Target Slot

choices.

Generic Reader: .function (object)
Package

cl-string-generator.

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

automatically generated reader method

Source

regex-class.lisp.

Target Slot

function.

Generic Reader: .greedyp (object)
Package

cl-string-generator.

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

automatically generated reader method

Source

regex-class.lisp.

Target Slot

greedyp.

Generic Reader: .maximum (object)
Package

cl-string-generator.

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

automatically generated reader method

Source

regex-class.lisp.

Target Slot

maximum.

Generic Reader: .minimum (object)
Package

cl-string-generator.

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

automatically generated reader method

Source

regex-class.lisp.

Target Slot

minimum.

Generic Reader: .number (object)
Package

cl-string-generator.

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

cl-string-generator.

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

cl-string-generator.

Methods
Reader Method: .seq ((seq seq))

automatically generated reader method

Source

regex-class.lisp.

Target Slot

seq.

Generic Reader: .str (object)
Package

cl-string-generator.

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

cl-string-generator.

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

cl-string-generator.

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

cl-string-generator.

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

cl-string-generator.

Methods
Reader Method: value-of ((condition value))
Source

generate.lisp.

Target Slot

value.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.5 Conditions

Condition: value
Package

cl-string-generator.

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.


Previous: , Up: Internals   [Contents][Index]

5.2.6 Classes

Class: alternation
Package

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
Direct slots
Slot: choices
Initargs

:choices

Readers

.choices.

Writers

This slot is read-only.

Class: back-reference
Package

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
Direct slots
Slot: number
Package

common-lisp.

Initargs

:number

Readers

.number.

Writers

This slot is read-only.

Class: random-char
Package

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
Direct slots
Slot: function
Package

common-lisp.

Initargs

:function

Readers

.function.

Writers

This slot is read-only.

Class: regex
Package

cl-string-generator.

Source

regex-class.lisp.

Direct subclasses
Class: register
Package

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
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

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
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

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
Direct slots
Slot: seq
Initargs

:seq

Readers

.seq.

Writers

This slot is read-only.

Class: str
Package

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods
Direct slots
Slot: str
Initargs

:str

Readers

.str.

Writers

This slot is read-only.

Class: void
Package

cl-string-generator.

Source

regex-class.lisp.

Direct superclasses

regex.

Direct methods

generate-aux.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   .  
C   F   G   M   R   S   V   W  
Index Entry  Section

%
%generate: Private ordinary functions

.
.choices: Private generic functions
.choices: Private generic functions
.function: Private generic functions
.function: Private generic functions
.greedyp: Private generic functions
.greedyp: Private generic functions
.maximum: Private generic functions
.maximum: Private generic functions
.minimum: Private generic functions
.minimum: Private generic functions
.number: Private generic functions
.number: Private generic functions
.number: Private generic functions
.regex: Private generic functions
.regex: Private generic functions
.regex: Private generic functions
.seq: Private generic functions
.seq: Private generic functions
.str: Private generic functions
.str: Private generic functions

C
convert: Private ordinary functions
convert-aux: Private ordinary functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-compound-parse-tree: Private generic functions
convert-sequence: Private ordinary functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions
convert-simple-parse-tree: Private generic functions

F
Function, %generate: Private ordinary functions
Function, convert: Private ordinary functions
Function, convert-aux: Private ordinary functions
Function, convert-sequence: Private ordinary functions
Function, generate: Public ordinary functions
Function, generate-using-handler: Private ordinary functions
Function, random-char: Private ordinary functions
Function, random-char-function: Private ordinary functions
Function, random-choice: Private ordinary functions
Function, random-digit-char: Private ordinary functions
Function, random-expected-char: Private ordinary functions
Function, random-integer: Private ordinary functions
Function, random-non-digit-char: Private ordinary functions
Function, random-non-whitespace-char: Private ordinary functions
Function, random-non-word-char: Private ordinary functions
Function, random-whitespace-char: Private ordinary functions
Function, random-word-char: Private ordinary functions
Function, string-append: Private ordinary functions
Function, value: Private ordinary functions
Function, word-char-p: Private ordinary functions

G
generate: Public ordinary functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-aux: Private generic functions
generate-using-handler: Private ordinary functions
Generic Function, .choices: Private generic functions
Generic Function, .function: Private generic functions
Generic Function, .greedyp: Private generic functions
Generic Function, .maximum: Private generic functions
Generic Function, .minimum: Private generic functions
Generic Function, .number: Private generic functions
Generic Function, .regex: Private generic functions
Generic Function, .seq: Private generic functions
Generic Function, .str: Private generic functions
Generic Function, convert-compound-parse-tree: Private generic functions
Generic Function, convert-simple-parse-tree: Private generic functions
Generic Function, generate-aux: Private generic functions
Generic Function, value-of: Private generic functions

M
Macro, select: Private macros
Method, .choices: Private generic functions
Method, .function: Private generic functions
Method, .greedyp: Private generic functions
Method, .maximum: Private generic functions
Method, .minimum: Private generic functions
Method, .number: Private generic functions
Method, .number: Private generic functions
Method, .regex: Private generic functions
Method, .regex: Private generic functions
Method, .seq: Private generic functions
Method, .str: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-compound-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, convert-simple-parse-tree: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, generate-aux: Private generic functions
Method, value-of: Private generic functions

R
random-char: Private ordinary functions
random-char-function: Private ordinary functions
random-choice: Private ordinary functions
random-digit-char: Private ordinary functions
random-expected-char: Private ordinary functions
random-integer: Private ordinary functions
random-non-digit-char: Private ordinary functions
random-non-whitespace-char: Private ordinary functions
random-non-word-char: Private ordinary functions
random-whitespace-char: Private ordinary functions
random-word-char: Private ordinary functions

S
select: Private macros
string-append: Private ordinary functions

V
value: Private ordinary functions
value-of: Private generic functions
value-of: Private generic functions

W
word-char-p: Private ordinary functions

Jump to:   %   .  
C   F   G   M   R   S   V   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   B   C   F   G   P   R   S   U   V  
Index Entry  Section

A
alternation: Private classes

B
back-reference: Private classes

C
cl-string-generator: The cl-string-generator system
cl-string-generator: The cl-string-generator package
cl-string-generator.asd: The cl-string-generator/cl-string-generator․asd file
Class, alternation: Private classes
Class, back-reference: Private classes
Class, random-char: Private classes
Class, regex: Private classes
Class, register: Private classes
Class, repetition: Private classes
Class, seq: Private classes
Class, str: Private classes
Class, void: Private classes
Condition, value: Private conditions
constants.lisp: The cl-string-generator/constants․lisp file
convert.lisp: The cl-string-generator/convert․lisp file

F
File, cl-string-generator.asd: The cl-string-generator/cl-string-generator․asd file
File, constants.lisp: The cl-string-generator/constants․lisp file
File, convert.lisp: The cl-string-generator/convert․lisp file
File, generate.lisp: The cl-string-generator/generate․lisp file
File, package.lisp: The cl-string-generator/package․lisp file
File, regex-class.lisp: The cl-string-generator/regex-class․lisp file
File, utils.lisp: The cl-string-generator/utils․lisp file

G
generate.lisp: The cl-string-generator/generate․lisp file

P
Package, cl-string-generator: The cl-string-generator package
package.lisp: The cl-string-generator/package․lisp file

R
random-char: Private classes
regex: Private classes
regex-class.lisp: The cl-string-generator/regex-class․lisp file
register: Private classes
repetition: Private classes

S
seq: Private classes
str: Private classes
System, cl-string-generator: The cl-string-generator system

U
utils.lisp: The cl-string-generator/utils․lisp file

V
value: Private conditions
void: Private classes

Jump to:   A   B   C   F   G   P   R   S   U   V