This is the clss Reference Manual, version 0.3.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:43:09 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
clss
A DOM tree searching engine based on CSS selectors.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/CLSS.git)
zlib
0.3.1
array-utils
(system).
plump
(system).
package.lisp
(file).
selector.lisp
(file).
parser.lisp
(file).
engine.lisp
(file).
pseudo-selectors.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
clss/clss.asd
clss/package.lisp
clss/selector.lisp
clss/parser.lisp
clss/engine.lisp
clss/pseudo-selectors.lisp
clss/selector.lisp
package.lisp
(file).
clss
(system).
make-any-constraint
(function).
make-attribute-constraint
(function).
make-class-constraint
(function).
make-clss-matcher
(function).
make-id-constraint
(function).
make-pseudo-constraint
(function).
make-selector
(function).
make-tag-constraint
(function).
make-type-constraint
(function).
make-group
(function).
clss/parser.lisp
selector.lisp
(file).
clss
(system).
css-escape
(function).
css-unescape
(function).
parse-selector
(function).
*valid-combinators*
(special variable).
ensure-selector
(function).
escapable
(function).
read-any-constraint
(function).
read-attribute-comparator
(function).
read-attribute-constraint
(function).
read-attribute-value
(function).
read-class-constraint
(function).
read-combinator
(function).
read-constraint
(function).
read-group
(function).
read-id-constraint
(function).
read-matcher
(function).
read-name
(function).
read-pseudo-args
(function).
read-pseudo-constraint
(function).
read-selector
(function).
read-tag-constraint
(function).
read-type-constraint
(function).
clss/engine.lisp
parser.lisp
(file).
clss
(system).
define-pseudo-selector
(macro).
match-constraint
(function).
match-group
(function).
match-group-backwards
(function).
match-matcher
(function).
match-selector
(function).
name
(reader method).
name
(reader method).
(setf name)
(writer method).
(setf name)
(writer method).
node-matches-p
(compiler macro).
node-matches-p
(function).
ordered-select
(compiler macro).
ordered-select
(function).
pseudo-selector
(function).
(setf pseudo-selector)
(function).
pseudo-selector-not-available
(condition).
remove-pseudo-selector
(function).
select
(compiler macro).
select
(function).
selector
(reader method).
(setf selector)
(writer method).
selector-malformed
(condition).
undefined-pseudo-selector
(condition).
*pseudo-selectors*
(special variable).
complete-match-pair
(condition).
find-substring
(function).
match-pair-breadth
(function).
match-pair-depth
(function).
value
(reader method).
(setf value)
(writer method).
clss/pseudo-selectors.lisp
engine.lisp
(file).
clss
(system).
match-nth
(function).
Packages are listed by definition order.
clss
org.shirakumo.clss
common-lisp
.
plump
.
css-escape
(function).
css-unescape
(function).
define-pseudo-selector
(macro).
make-any-constraint
(function).
make-attribute-constraint
(function).
make-class-constraint
(function).
make-clss-matcher
(function).
make-id-constraint
(function).
make-pseudo-constraint
(function).
make-selector
(function).
make-tag-constraint
(function).
make-type-constraint
(function).
match-constraint
(function).
match-group
(function).
match-group-backwards
(function).
match-matcher
(function).
match-selector
(function).
name
(generic reader).
(setf name)
(generic writer).
node-matches-p
(compiler macro).
node-matches-p
(function).
ordered-select
(compiler macro).
ordered-select
(function).
parse-selector
(function).
pseudo-selector
(function).
(setf pseudo-selector)
(function).
pseudo-selector-not-available
(condition).
remove-pseudo-selector
(function).
select
(compiler macro).
select
(function).
selector
(generic reader).
(setf selector)
(generic writer).
selector-malformed
(condition).
undefined-pseudo-selector
(condition).
*pseudo-selectors*
(special variable).
*valid-combinators*
(special variable).
complete-match-pair
(condition).
ensure-selector
(function).
escapable
(function).
find-substring
(function).
make-group
(function).
match-nth
(function).
match-pair-breadth
(function).
match-pair-depth
(function).
read-any-constraint
(function).
read-attribute-comparator
(function).
read-attribute-constraint
(function).
read-attribute-value
(function).
read-class-constraint
(function).
read-combinator
(function).
read-constraint
(function).
read-group
(function).
read-id-constraint
(function).
read-matcher
(function).
read-name
(function).
read-pseudo-args
(function).
read-pseudo-constraint
(function).
read-selector
(function).
read-tag-constraint
(function).
read-type-constraint
(function).
value
(generic reader).
(setf value)
(generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a new pseudo-selector of NAME.
NAME — A symbol or string naming the selector (case insensitive always).
NODENAME — A variable symbol the matched node is bound to.
ARGS-LAMBDA — A lambda-list of the expected arguments for the pseudo-selector.
Note that keyword arguments make no sense in this context.
BODY ::= form*
clss
.
Escape all the invalid CSS characters to their safe counterparts.
clss
.
Get the original contents of the escaped STRING.
clss
.
Attempts to match the CONSTRAINT form against the node. Returns NIL if it fails to do so, unspecified otherwise.
clss
.
Match a matcher group against the root-node and possibly all its children. Returns an array of mached nodes.
clss
.
Attempts to match a matcher against a node. Returns T if all constraints match, NIL otherwise.
clss
.
Match a selector against the root-node and possibly all its children. Returns an array of matched nodes.
clss
.
Tests whether the node matches the selector.
SELECTOR — A CSS-selector string or a compiled selector list. NODE — The node to test.
clss
.
Match the given selector against the root-node and possibly all its children.
Return an array of matching nodes ordered by their depth-first
traversal appearance in the DOM.
SELECTOR — A CSS-selector string or a compiled selector list. ROOT-NODE — A single node, list or vector of nodes to start matching from.
clss
.
Parse a selector string into its "compiled" list form.
clss
.
Returns the pseudo-selector function associated with NAME, if any.
clss
.
Sets FUNCTION as the pseudo-selector for NAME.
clss
.
Removes the pseudo-selector associated with NAME.
clss
.
Match the given selector against the root-node and possibly all its children.
Returns an array of matched nodes.
SELECTOR — A CSS-selector string or a compiled selector list.
ROOT-NODE — A single node, list or vector of nodes to start matching from.
SEARCH-TYPE — Select the search algorithm, options are ":depth-first" and ":breadth-first".
clss
.
clss
.
undefined-pseudo-selector
)) ¶undefined-pseudo-selector
)) ¶pseudo-selector-not-available
)) ¶pseudo-selector-not-available
)) ¶clss
.
selector-malformed
)) ¶selector-malformed
)) ¶Condition signalled when a pseudo selector is defined according to spec, but makes no sense in the context of CLSS and has thus been left unimplemented.
Signalled when a selector or matcher has been found to be malformed.
This really shouldn’t happen unless you’re passing raw lists
for the selector to the matcher.
Condition signalled when trying to use a pseudo selector that has not been defined. This is signalled at match-time, rather than at selector-compile-time.
Hash table for pseudo selector functions.
Links string names to functions of one or more arguments.
clss
.
A helper function to decide whether a part of identifier needs escaping.
clss
.
Returns ITEM if it is an element of STRING split by the SPLIT character.
clss
.
Match a combinator and matcher pair against a list of nodes. Returns a vector of matching nodes.
clss
.
Match a combinator and matcher pair against a list of nodes. For every match the function specified in "MATCHING-NODES-PROCESSOR" is called with the found match as the only argument.
clss
.
Reads an attribute comparator string and returns it if found.
clss
.
Reads a complete attribute constraint and returns it.
clss
.
Reads the combinator between matchers and returns it.
clss
.
Read any constraint. Dispatches depending on the next character consumed.
clss
.
Reads an ID attribute constraint and returns it.
clss
.
Read a matcher (a sequence of constraints) and return it.
clss
.
Reads a complete pseudo constraint and returns it.
clss
.
Reads a DOM type constraint and returns it.
clss
.
clss
.
complete-match-pair
)) ¶complete-match-pair
)) ¶Jump to: | (
C D E F G M N O P R S V |
---|
Jump to: | (
C D E F G M N O P R S V |
---|
Jump to: | %
*
S |
---|
Jump to: | %
*
S |
---|
Jump to: | C E F P S U |
---|
Jump to: | C E F P S U |
---|