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

The pregexp Reference Manual

This is the pregexp Reference Manual, version 20200129, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:20:22 2024 GMT+0.

Next: Systems, Previous: The pregexp Reference Manual, Up: The pregexp Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The pregexp Reference Manual [Contents][Index]

2 Systems

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

pregexp

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

2.1 `pregexp`

Portable regular expressions for Common Lisp

Author

Dorai Sitaram

Version

20200129

Source

pregexp.asd.

Child Components

packages.lisp (file).
pregexp.lisp (file).

Next: Packages, Previous: Systems, Up: The pregexp Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: pregexp/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `pregexp/pregexp.asd`

Source: pregexp.asd.
Parent Component: pregexp (system).
ASDF Systems: pregexp.

Next: pregexp/pregexp.lisp, Previous: pregexp/pregexp.asd, Up: Lisp [Contents][Index]

3.1.2 `pregexp/packages.lisp`

Source: pregexp.asd.
Parent Component: pregexp (system).
Packages: pregexp.

Previous: pregexp/packages.lisp, Up: Lisp [Contents][Index]

3.1.3 `pregexp/pregexp.lisp`

Dependency

packages.lisp (file).

Source

pregexp.asd.

Parent Component

pregexp (system).

Public Interface

pregexp (function).
pregexp-match (function).
pregexp-match-positions (function).
pregexp-quote (function).
pregexp-replace (function).
pregexp-replace* (function).
pregexp-split (function).

Internals

*pregexp-comment-char* (special variable).
*pregexp-space-sensitive-p* (special variable).
*pregexp-version* (special variable).
pregexp-at-word-boundary-p (function).
pregexp-char-word? (function).
pregexp-check-if-in-char-class-p (function).
pregexp-make-backref-list (function).
pregexp-match-positions-aux (function).
pregexp-read-branch (function).
pregexp-read-char-list (function).
pregexp-read-cluster-type (function).
pregexp-read-escaped-char (function).
pregexp-read-escaped-number (function).
pregexp-read-nums (function).
pregexp-read-pattern (function).
pregexp-read-piece (function).
pregexp-read-posix-char-class (function).
pregexp-read-subpattern (function).
pregexp-recur (macro).
pregexp-replace-aux (function).
pregexp-string-match (function).
pregexp-whitespacep (function).
pregexp-wrap-quantifier-if-any (function).

Next: Definitions, Previous: Files, Up: The pregexp Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

pregexp

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

4.1 `pregexp`

Source

packages.lisp.

Nickname

pre

Use List

common-lisp.

Public Interface

pregexp (function).
pregexp-match (function).
pregexp-match-positions (function).
pregexp-quote (function).
pregexp-replace (function).
pregexp-replace* (function).
pregexp-split (function).

Internals

*pregexp-comment-char* (special variable).
*pregexp-space-sensitive-p* (special variable).
*pregexp-version* (special variable).
pregexp-at-word-boundary-p (function).
pregexp-char-word? (function).
pregexp-check-if-in-char-class-p (function).
pregexp-make-backref-list (function).
pregexp-match-positions-aux (function).
pregexp-read-branch (function).
pregexp-read-char-list (function).
pregexp-read-cluster-type (function).
pregexp-read-escaped-char (function).
pregexp-read-escaped-number (function).
pregexp-read-nums (function).
pregexp-read-pattern (function).
pregexp-read-piece (function).
pregexp-read-posix-char-class (function).
pregexp-read-subpattern (function).
pregexp-recur (macro).
pregexp-replace-aux (function).
pregexp-string-match (function).
pregexp-whitespacep (function).
pregexp-wrap-quantifier-if-any (function).

Next: Indexes, Previous: Packages, Up: The pregexp Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: pregexp (s) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-match (pat str &optional start end) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-match-positions (pat str &optional start end) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-quote (s) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-replace (pat str ins) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-replace* (pat str ins) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-split (pat str) ¶

Package: pregexp.
Source: pregexp.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Macros
Ordinary functions

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

5.2.1 Special variables

Special Variable: *pregexp-comment-char* ¶

Package: pregexp.
Source: pregexp.lisp.

Special Variable: *pregexp-space-sensitive-p* ¶

Package: pregexp.
Source: pregexp.lisp.

Special Variable: *pregexp-version* ¶

Package: pregexp.
Source: pregexp.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Macros

Macro: pregexp-recur (name varvals &rest body) ¶

Package: pregexp.
Source: pregexp.lisp.

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

5.2.3 Ordinary functions

Function: pregexp-at-word-boundary-p (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-char-word? (c) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-check-if-in-char-class-p (c char-class) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-make-backref-list (re) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-match-positions-aux (re s sn start n i) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-branch (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-char-list (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-cluster-type (s i) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-escaped-char (s i) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-escaped-number (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-nums (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-pattern (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-piece (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-posix-char-class (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-read-subpattern (s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-replace-aux (str ins n backrefs) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-string-match (s1 s i n sk fk) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-whitespacep (c) ¶

Package: pregexp.
Source: pregexp.lisp.

Function: pregexp-wrap-quantifier-if-any (re s i n) ¶

Package: pregexp.
Source: pregexp.lisp.

Previous: Definitions, Up: The pregexp Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	F M P

	Index Entry	Section

F
	`Function, pregexp`:	Public ordinary functions
	`Function, pregexp-at-word-boundary-p`:	Private ordinary functions
	`Function, pregexp-char-word?`:	Private ordinary functions
	`Function, pregexp-check-if-in-char-class-p`:	Private ordinary functions
	`Function, pregexp-make-backref-list`:	Private ordinary functions
	`Function, pregexp-match`:	Public ordinary functions
	`Function, pregexp-match-positions`:	Public ordinary functions
	`Function, pregexp-match-positions-aux`:	Private ordinary functions
	`Function, pregexp-quote`:	Public ordinary functions
	`Function, pregexp-read-branch`:	Private ordinary functions
	`Function, pregexp-read-char-list`:	Private ordinary functions
	`Function, pregexp-read-cluster-type`:	Private ordinary functions
	`Function, pregexp-read-escaped-char`:	Private ordinary functions
	`Function, pregexp-read-escaped-number`:	Private ordinary functions
	`Function, pregexp-read-nums`:	Private ordinary functions
	`Function, pregexp-read-pattern`:	Private ordinary functions
	`Function, pregexp-read-piece`:	Private ordinary functions
	`Function, pregexp-read-posix-char-class`:	Private ordinary functions
	`Function, pregexp-read-subpattern`:	Private ordinary functions
	`Function, pregexp-replace`:	Public ordinary functions
	`Function, pregexp-replace*`:	Public ordinary functions
	`Function, pregexp-replace-aux`:	Private ordinary functions
	`Function, pregexp-split`:	Public ordinary functions
	`Function, pregexp-string-match`:	Private ordinary functions
	`Function, pregexp-whitespacep`:	Private ordinary functions
	`Function, pregexp-wrap-quantifier-if-any`:	Private ordinary functions

M
	`Macro, pregexp-recur`:	Private macros

P
	`pregexp`:	Public ordinary functions
	`pregexp-at-word-boundary-p`:	Private ordinary functions
	`pregexp-char-word?`:	Private ordinary functions
	`pregexp-check-if-in-char-class-p`:	Private ordinary functions
	`pregexp-make-backref-list`:	Private ordinary functions
	`pregexp-match`:	Public ordinary functions
	`pregexp-match-positions`:	Public ordinary functions
	`pregexp-match-positions-aux`:	Private ordinary functions
	`pregexp-quote`:	Public ordinary functions
	`pregexp-read-branch`:	Private ordinary functions
	`pregexp-read-char-list`:	Private ordinary functions
	`pregexp-read-cluster-type`:	Private ordinary functions
	`pregexp-read-escaped-char`:	Private ordinary functions
	`pregexp-read-escaped-number`:	Private ordinary functions
	`pregexp-read-nums`:	Private ordinary functions
	`pregexp-read-pattern`:	Private ordinary functions
	`pregexp-read-piece`:	Private ordinary functions
	`pregexp-read-posix-char-class`:	Private ordinary functions
	`pregexp-read-subpattern`:	Private ordinary functions
	`pregexp-recur`:	Private macros
	`pregexp-replace`:	Public ordinary functions
	`pregexp-replace*`:	Public ordinary functions
	`pregexp-replace-aux`:	Private ordinary functions
	`pregexp-split`:	Public ordinary functions
	`pregexp-string-match`:	Private ordinary functions
	`pregexp-whitespacep`:	Private ordinary functions
	`pregexp-wrap-quantifier-if-any`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`pregexp-comment-char`:	Private special variables
	`pregexp-space-sensitive-p`:	Private special variables
	`pregexp-version`:	Private special variables

S
	`Special Variable, pregexp-comment-char`:	Private special variables
	`Special Variable, pregexp-space-sensitive-p`:	Private special variables
	`Special Variable, pregexp-version`:	Private special variables

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

A.4 Data types

Jump to:	F P S

	Index Entry	Section

F
	`File, packages.lisp`:	The pregexp/packages․lisp file
	`File, pregexp.asd`:	The pregexp/pregexp․asd file
	`File, pregexp.lisp`:	The pregexp/pregexp․lisp file

P
	`Package, pregexp`:	The pregexp package
	`packages.lisp`:	The pregexp/packages․lisp file
	`pregexp`:	The pregexp system
	`pregexp`:	The pregexp package
	`pregexp.asd`:	The pregexp/pregexp․asd file
	`pregexp.lisp`:	The pregexp/pregexp․lisp file

S
	`System, pregexp`:	The pregexp system

The pregexp Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 pregexp

3 Files

3.1 Lisp

3.1.1 pregexp/pregexp.asd

3.1.2 pregexp/packages.lisp

3.1.3 pregexp/pregexp.lisp

4 Packages

4.1 pregexp

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `pregexp`

3.1.1 `pregexp/pregexp.asd`

3.1.2 `pregexp/packages.lisp`

3.1.3 `pregexp/pregexp.lisp`

4.1 `pregexp`