This is the cl-match-patterns Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 11:54:13 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-match-patternsDescribe cl-match-patterns here
Artyom Bologov
(GIT https://codeberg.org/aartaka/cl-match-patterns.git)
BSD-2 Clause
0.0.0
cl-ppcre (system).
quri (system).
package.lisp (file).
cl-match-patterns.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-match-patterns/cl-match-patterns.asdcl-match-patterns/package.lispcl-match-patterns/cl-match-patterns.lispcl-match-patterns/cl-match-patterns.asdcl-match-patterns (system).
cl-match-patterns/cl-match-patterns.lisppackage.lisp (file).
cl-match-patterns (system).
host (reader method).
(setf host) (writer method).
malformed-pattern (condition).
malformed-pattern-pattern (reader method).
malformed-pattern-problem (reader method).
match (function).
parse (function).
path (reader method).
(setf path) (writer method).
pattern (class).
scheme (reader method).
(setf scheme) (writer method).
-> (macro).
Packages are listed by definition order.
cl-match-patterns‘cl-match-patterns’ package provides two main entry points:
- ‘parse’ takes a string representation of a match pattern and returns
a more structured ‘pattern’
- ‘match’ takes a URL (string of quri:uri) to match and the ‘pattern’ to
match; and returns whether these match.
‘pattern’ class is the structured representation of the match pattern,
with ‘scheme’, ‘host’, and ‘path’ being its parts.
‘parse’ and ‘match’ throw ‘malformed-pattern’ when the pattern is broken.
common-lisp.
host (generic reader).
(setf host) (generic writer).
malformed-pattern (condition).
malformed-pattern-pattern (generic reader).
malformed-pattern-problem (generic reader).
match (function).
parse (function).
path (generic reader).
(setf path) (generic writer).
pattern (class).
scheme (generic reader).
(setf scheme) (generic writer).
-> (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Match the URL against the PATTERN.
Returns four boolean values:
- Whether the URL matches PATTERN as a whole
- Whether the scheme matched
- Whether the host matched
- Whether the path matched
Parse the string PATTERN into a ‘pattern’ object.
Throws a lot of errors on malformed PATTERN, so tread carefully and catch.
In case USE-PATHNAMES-P is true, use pathnames for URL paths. Stricter
in path checking, but doesn’t allow partially wild path
components (/a*/)
malformed-pattern)) ¶malformed-pattern)) ¶pattern)) ¶pattern)) ¶Match the path of the URL.
- :WILDCARD – match any path and query
- A string – match a regex string against the provided path and query
- A pathname – to be matched with ‘pathname-match-p’
path.
pattern)) ¶pattern)) ¶Match scheme of the URL.
Possible values:
- :WILDCARD – match http, https, ws, wss (when configured in ‘match’)
- :TRUE-WILDCARD – match any scheme (never use directly, only when ‘parse’-d)
- A string – match literal scheme in its entirety.
Representation of a match pattern prepared for ‘match’-ing.
Uses regex strings in ‘path’ and ‘query’ and literal strings in ‘scheme’ and ‘host’.
All the otherwise, allows :WILDCARD in most cases and some special values on top.
Match scheme of the URL.
Possible values:
- :WILDCARD – match http, https, ws, wss (when configured in ‘match’)
- :TRUE-WILDCARD – match any scheme (never use directly, only when ‘parse’-d)
- A string – match literal scheme in its entirety.
(or string (eql :wildcard) (eql :true-wildcard))
:scheme
Match the host/domain of the URL.
Possible values:
- :WILDCARD – match any host
- (:WILDCARD HOST) – match any host/domain under a given HOST
- A string – match whole host literally
(or string (eql :wildcard) (cons (eql :wildcard) (cons string null)))
:host
host.
Shorter ftype declaration for NAME.
| Jump to: | (
-
F G H M P S |
|---|
| Jump to: | (
-
F G H M P S |
|---|
| Jump to: | H P S |
|---|
| Jump to: | H P S |
|---|
| Jump to: | C F M P S |
|---|
| Jump to: | C F M P S |
|---|