The lquery Reference Manual

This is the lquery Reference Manual, version 3.2.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:18:18 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 lquery

A library to allow jQuery-like HTML/DOM manipulation.

Maintainer

Nicolas Hafner <>

Author

Nicolas Hafner <>

Home Page

https://Shinmera.github.io/lquery/

Source Control

(GIT https://github.com/Shinmera/lquery.git)

Bug Tracker

https://github.com/Shinmera/lquery/issues

License

zlib

Version

3.2.1

Dependencies
  • array-utils (system).
  • form-fiddle (system).
  • plump (system).
  • clss (system).
Source

lquery.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 lquery/lquery.asd

Source

lquery.asd.

Parent Component

lquery (system).

ASDF Systems

lquery.


3.1.2 lquery/package.lisp

Source

lquery.asd.

Parent Component

lquery (system).

Packages

3.1.3 lquery/toolkit.lisp

Dependency

package.lisp (file).

Source

lquery.asd.

Parent Component

lquery (system).

Public Interface
Internals

3.1.4 lquery/lquery.lisp

Dependency

toolkit.lisp (file).

Source

lquery.asd.

Parent Component

lquery (system).

Public Interface
Internals

3.1.5 lquery/lquery-funcs.lisp

Dependency

lquery.lisp (file).

Source

lquery.asd.

Parent Component

lquery (system).

Public Interface
Internals

parent-lists (function).


3.1.6 lquery/lquery-macros.lisp

Dependency

lquery-funcs.lisp (file).

Source

lquery.asd.

Parent Component

lquery (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 lquery

Source

package.lisp.

Nickname

org.shirakumo.lquery

Use List
  • array-utils.
  • common-lisp.
Public Interface
Internals

4.2 lquery-macros

Source

package.lisp.

Nickname

org.shirakumo.lquery.macros

Public Interface

4.3 lquery-funcs

Source

package.lisp.

Nickname

org.shirakumo.lquery.funcs

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *lquery-master-document*

The master document used at the beginning of a chain.

Package

lquery.

Source

toolkit.lisp.


5.1.2 Macros

Macro: $ (&body actions)

Performs lQuery operations on the current document.

Each argument is executed in sequence. The arguments are evaluated according to the defined argument-handlers. By default, the following cases are handled:
* STRING Translates to a CLSS:QUERY on the current elements.
* FUNCTION Translates to a function call with the list of nodes as argument.
* SYMBOL Delegates to the value handlers.
* LIST Lists are transformed according to their first element, which must be a symbol. If the symbol’s name corresponds to a function found in the LQUERY-MACROS package, The form is assembled according to that function. Otherwise if it corresponds to an LQUERY-FUNCS function, it is expanded into a call to that function. If the symbol cannot be found in either package, it is put back in place, but the call itself is assembled like so: (FUNCTION PREVIOUS-RESULT ARGUMENT*)

Values are handled at runtime according to the defined variable-handlers. By default, the following cases are handled at run time:
* STRING Performs a CLSS:QUERY on the current elements.
* DOM:NODE Replaces the current set of nodes with just this node.
* FUNCTION Calls the given function with the current set of nodes as argument.
* LIST Lists are transformed into a proper vector.
* ARRAY Arrays are transformed into a proper vector.
* VECTOR Vectors that are not adjustable are transformed into a proper vector.
* T Any other value simply replaces the current list of nodes.

Package

lquery.

Source

lquery.lisp.

Macro: $1 (&body actions)

This is the same as $, except it automatically uses NODE at the end and thus only returns the first result, if any.

Package

lquery.

Source

lquery.lisp.

Macro: define-argument-handler (type (argument-name operator-name) &body body)

Defines a new argument handler that decides what to do with a certain type of argument at compile-time.

TYPE — A type or EQL specifier.
ARGUMENT-NAME — Symbol bound to the argument.
OPERATOR-NAME — Symbol bound to the object being operated on.
BODY ::= form*

Package

lquery.

Source

lquery.lisp.

Macro: define-lquery-function (name (node-name &rest arguments) &body body)

Defines a new node function. This is the main mechanism by which node manipulations are defined. All lquery functions are automatically created in the lquery-funcs package.

NAME — A symbol naming the lquery function. Automatically interned in the LQUERY-FUNCS package. NODE-NAME — Symbol bound to the current node.
ARGUMENTS — A lambda-list specifying the arguments for the function.
BODY ::= form*

Package

lquery.

Source

lquery.lisp.

Macro: define-lquery-list-function (name (vector-name &rest arguments) &body body)

Defines a new function that operates on the current node array instead of individual elements.
All lquery functions are automatically created in the lquery-funcs package.

NAME — A symbol naming the lquery function. Automatically interned in the LQUERY-FUNCS package. VECTOR-NAME — Symbol bound to the node vector.
ARGUMENTS — A lambda-list specifying the arguments for the function.
BODY ::= form*

Package

lquery.

Source

lquery.lisp.

Macro: define-lquery-macro (name (previous-form &rest arguments) &body body)

Define a new lquery local macro.
All lquery macros are automatically created in the lquery-macros package.

NAME — A symbol naming the lquery macro. Automatically interned in the LQUERY-MACROS package. PREVIOUS-FORM — Symbol bound to the so far assembled form, the previous value so to speak.
ARGUMENTS — A lambda-list specifying the arguments for the macro (note that this must be a standard lambda-list). BODY ::= form*

Package

lquery.

Source

lquery.lisp.

Macro: define-lquery-subroutine (name (&rest arguments) &body body)

Defines a shorthand function. The body is a set of lQuery instructions as you’d use in $.

NAME — A symbol naming the subroutine. Automatically interned in the LQUERY-FUNCS package. ARGUMENTS — A lambda-list specifying the arguments for the function.
BODY ::= lquery-form*

Package

lquery.

Source

lquery.lisp.

Macro: define-value-handler (type (variable-name operator-name) &body body)

Defines a new symbol handler that decides what to do with a certain type of symbol at run-time (variable type).

TYPE — A type or EQL specifier.
VARIABLE-NAME — Symbol bound to the argument.
OPERATOR-NAME — Symbol bound to the object being operated on.
BODY ::= form*

Package

lquery.

Source

lquery.lisp.

Macro: with-master-document ((&optional doc) &body body)

Surrounds the body in a binding for the *lquery-master-document* to ensure it does not get clobbered.

Package

lquery.

Source

toolkit.lisp.


5.1.3 Ordinary functions

Function: $ (nodes &rest forms)

Shorthand to allow dropping the package prefix when nesting $/$1.

See $

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: $1 (nodes &rest forms)

Shorthand to allow dropping the package prefix when nesting $/$1.

See $1

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: add (working-nodes selector-or-nodes)

Add elements to the set of matched elements.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: add-class (node &rest classes)

Adds the specified class(es) to the set of matched elements.

The following types are handled for each class to add:
NULL — No class is added.
STRING — The string is added as a class.
SYMBOL — The symbol name, downcased, is added as a class. LIST — Add all classes in the list. Each item must be one of the above types.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: after (nodes html-or-nodes)

Insert content (in html-string or node-list form) after each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: ancestor (working-nodes)

Find the common ancestor of all elements.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: append (nodes html-or-nodes)

Insert content (in html-string or node-list form) to the end of each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: append-to (working-nodes selector-or-nodes)

Insert every element to the end of the target(s).

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: attr (node &rest pairs)

Retrieve or set attributes on a node.
The value on a node is turned into a string using PRINC-TO-STRING. If a value is NIL, the associated attribute is removed.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: before (nodes html-or-nodes)

Insert content (in html-string or node-list form) before each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: child-index (node)

Returns the index of the element within its parent, also counting text nodes. See index() otherwise.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: children (nodes &optional selector)

Get the children of each element, optionally filtered by a selector.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: clone (node)

Create a deep copy of the set of matched elements.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: closest (node selector)

For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree. If no matching element can be found the root is entered instead.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: combine (nodes &rest calls)

COMBINES multiple lquery function calls into one by gathering them into a list for each element.

($ (combine (text) (attr :a))) would be equivalent to
($ (map #’(lambda (node) (list (lquery-funcs:text node) (lquery-funcs:attr node :a))))) This construct is especially useful in combination with MAP-APPLY.

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: contains (nodes string)

Select all elements that contain the specified text.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: contents (nodes)

Get the children of each element, including text and comment nodes.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: copy-proper-vector (sequence &key transform)

Copies the sequence into a new proper vector.

Package

lquery.

Source

toolkit.lisp.

Function: css (node &rest pairs)

Retrieve or set css style attributes on a node.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: data (node &rest pairs)

Retrieve or set data attributes on a node. This is a convenience method and uses attr in the back.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: deepest (node)

Returns the innermost (left-bound) child element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: detach (nodes &optional selector)

Removes the node (optionally filtered by the selector) from the document. Alias for remove()

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: each (nodes fun &key replace)

Execute the specified function on each element until NIL is returned or all elements have been processed. The original set of elements is returned if replace is NIL.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: empty (node)

Remove all child nodes from the set of matched elements.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: empty-p (node)

Check if the node contains no children and/or only empty (whitespace) text nodes. If it is empty, T is returned, otherwise NIL.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: ensure-proper-vector (var)

Ensure that the variable is a proper vector.

Package

lquery.

Source

toolkit.lisp.

Function: eq (working-nodes index)

Reduce the set of matched elements to the one at the specified index

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: eval (nodes form)

Evaluates the form at compile-time and puts its resulting value in place.

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: even (working-nodes)

Selects even elements, 1-indexed

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: filter (nodes selector-or-function)

Reduce the set of matched elements to those that match the selector or pass the function’s test.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: find (nodes selector-or-function &key test-self)

Get the descendants of each element filtered by selector or function.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: first (working-nodes)

Reduce the set of matched elements to the first in the set.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: function (nodes name)

Macro to allow #’foo to be used in lquery chains.

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: gt (working-nodes index)

Select all elements at a greater than index(0) within the matched set.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: has (nodes selector-or-nodes)

Reduce the set of matched elements to those that have a descendant that matches the selector or element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: has-class (working-nodes class)

Determine whether any of the matched elements are assigned to the given class.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: hide (working-nodes)

Hide the matched elements (short for (css "display" "none")).

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: html (node &optional new-content)

Get the HTML contents of the elements or set the HTML contents of every matched element. The new content can be either a plump node, root, pathname, or string. If it is none of those, it is treated as a string via PRINC-TO-STRING

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: html-file (working-nodes pathname)

Read an HTML file and insert its contents into each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: index (node)

Find the index of the node within its parent.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: initialize (document)

Sets the *lquery-master-document* variable to the provided document.

Package

lquery.

Source

toolkit.lisp.

Function: initialize (nodes &rest init-calls)

See lquery function INITIALIZE.

This is merely a performance macro to avoid the unnecessary default allocation of a vector.

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: initialize (working-nodes document)

Re-initializes lQuery with a new page.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: inline (nodes form)

Treats the form as if the evaluated value was put literally in place.

See DETERMINE-VALUE.

Package

lquery-macros.

Source

lquery-macros.lisp.

Function: insert-after (working-nodes selector-or-nodes)

Insert every element after the target.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: insert-before (working-nodes selector-or-nodes)

Insert every element before the target.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: is (working-nodes selector-or-nodes)

Check the current elements against a selector or list of elements and return true if at least one of them matches.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: is-empty (node)

Check if the node contains no children and/or only empty (whitespace) text nodes. If it is empty, T is returned, otherwise NIL. Alias of EMPTY-P

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: last (working-nodes)

Reduce the set of matched elements to the final one in the set.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: length (working-nodes)

Returns the number of elements in the list.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: load-page (file-or-string)

Load the given file or string into a HTML DOM.

Package

lquery.

Source

toolkit.lisp.

Function: lt (working-nodes index)

Select all elements at an index less than the index within the matched set.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: make-proper-vector (&key size initial-element initial-contents fill-pointer)

Creates a new proper vector.

Package

lquery.

Source

toolkit.lisp.

Function: map (working-nodes function)

Pass each element through a function (which has to accept one argument, the node), returning the list of all results.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: map-apply (working-nodes function)

Pass each element through a function by apply, returning the vector of all results. This is commonly useful in combination with COMBINE.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: next (nodes &optional selector)

Get the immediately following sibling of each element (if there is one). If a selector is provided, the sibling is only included if it matches.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: next-all (nodes &optional selector)

Get all following siblings of each element. If a selector is provided, the sibling is only included if it matches.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: next-until (nodes selector-or-nodes)

Get all following silings of each element up to (excluding) the element matched by the selector or node list.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: node (working-nodes &optional n)

Return the specified node (default first) directly, without encompassing it into a vector if it exists. Otherwise return NIL.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: not (working-nodes selector-or-nodes)

Remove matching elements from the working elements.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: not-empty (node)

Check if the node contains no children and/or only empty (whitespace) text nodes. If the node is effectively empty NIL is returned, otherwise T

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: odd (working-nodes)

Select all odd elements from the current set, 1-indexed.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: parent (nodes &optional selector)

Get the parent of each element, optionally filtered by a selector.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: parents (nodes &optional selector)

Get the ancestors of each element, optionally filtered by a selector. Closest parent first.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: parents-until (nodes selector-or-nodes)

Get the ancestors of each element, up to (excluding) the element matched by the selector or node list. Closest parent first

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: parse-html (html)

Build the given string into DOM objects related to the master document.

Package

lquery.

Source

toolkit.lisp.

Function: prepend (nodes html-or-nodes)

Insert content, specified by the parameter, to the beginning of each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: prepend-to (working-nodes selector-or-nodes)

Insert every element to the beginning of the target(s).

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: prev (nodes &optional selector)

Get the immediately preceding sibling of each element (if there is one). If a selector is provided, the sibling is only included if it matches.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: prev-all (nodes &optional selector)

Get all preceeding siblings of each element. If a selector is provided, the sibling is only included if it matches.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: prev-until (nodes selector-or-nodes)

Get all preceeding silings of each element down to (excluding) the element matched by the selector or node list.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: remove (node &optional selector)

Remove the set of matched elements from the DOM.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: remove-attr (node &rest attributes)

Remove attributes from each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: remove-class (node &rest classes)

Remove classes from each element.

Each class in the list can be of the following types:
NULL — Nothing is done.
STRING — Matching classes by string= are removed.
SYMBOL — Matching classes against the symbol name by string-equal are removed. LIST — Add all classes in the list. Each item must be one of
the above types.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: remove-data (node &rest data)

Remove data attributes from each element. This is a convenience method and uses remove-attr in the back.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: render-text (node)

Return the "rendered" representation of the text inside the node and its children.

In effect the text is gathered from the component and all of
its children, but transforming the text in such a way that:
- All ASCII white space (Space, Tab, CR, LF) is converted into spaces.
- There are no consecutive spaces.
- There are no spaces at the beginning or end.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: replace-all (working-nodes selector-or-nodes)

Replace each in the set of matched elements with the current nodes.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: replace-with (working-nodes html-or-nodes)

Replace each element with the provided new content and return the set of elements that was removed.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: root (working-nodes)

Returns to the root. Essentially traverses up the tree of the first element in the set until the root is reached.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: serialize (node &optional stream format)

Serialize the node into a string.

Allows two optional arguments:
STREAM — NIL to return a string, or a stream to output to. FORMAT — One of :DEFAULT, :HTML, :XML to designate the way in which to invoke Plump’s serializer.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: show (working-nodes)

Display the matched elements (short for (css :display ’block’))

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: siblings (nodes &optional selector)

Get the siblings of each element, optionally filtered by a selector.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: size (working-nodes)

Return the number of elements in the list.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: slice (working-nodes start &optional end)

Reduce the set of matched elements to a subset specified by a range of indices

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: splice (node)

Splice the element’s contents in place of itself.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: text (node &optional text)

Get the combined text contents of each element, including their descendants. If text is set, all text nodes are removed and a new text node is appended to the end of the node. If text is NIL, all direct text nodes are removed from the node. If text is not a string, it is transformed into one by PRINC-TO-STRING.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: toggle-class (node &rest classes)

Add or remove one or more classes from each element, depending on their presence within the element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: unwrap (node)

Remove the parents of the set of matched elements from the DOM, inserting the parents children in place of it.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: val (node &optional value)

Get the current values or set the value of every matched element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: wrap (nodes html-or-nodes)

Wrap an HTML structure around each element. Note that always the first node of the structure to wrap is chosen.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: wrap-all (working-nodes html-or-nodes)

Wrap an HTML structure around all elements and put it in place of the first element, removing all other elements from their position.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: wrap-inner (nodes html-or-nodes)

Wrap an HTML structure around the contents of each element.

Package

lquery-funcs.

Source

lquery-funcs.lisp.

Function: write-to-file (working-nodes file &key if-does-not-exist if-exists)

Write the serialized node to the file. Note that always only the first element is written.

Package

lquery-funcs.

Source

lquery-funcs.lisp.


5.2 Internals


5.2.1 Macros

Macro: deflqfun (name args &rest forms)
Package

lquery.

Source

lquery.lisp.


5.2.2 Ordinary functions

Function: %$ (actions)
Package

lquery.

Source

lquery.lisp.

Function: assure-attribute (symbol-or-string)
Package

lquery.

Source

toolkit.lisp.

Function: build-elements (html)
Package

lquery.

Source

toolkit.lisp.

Function: classes (node)
Package

lquery.

Source

toolkit.lisp.

Function: funcs-or-select (object)

Return the object as a function or use it to construct a node-matches? function.

Package

lquery.

Source

toolkit.lisp.

Function: get-css-styles (node)
Package

lquery.

Source

toolkit.lisp.

Function: mkstr (&rest args)

Concatenates args by printing into string.

Package

lquery.

Source

toolkit.lisp.

Function: nodes-or-build (object)

Clone the object as a node list or use it to build a new HTML node.

Package

lquery.

Source

toolkit.lisp.

Function: nodes-or-select (object &optional root)

Return the object as a node list or use it to form a select query.

Package

lquery.

Source

toolkit.lisp.

Function: nodes-or-selector-func (object)

Build a function matching the selector or checking the equality/inclusion of the object.

Package

lquery.

Source

toolkit.lisp.

Function: parent-lists (nodes)
Package

lquery.

Source

lquery-funcs.lisp.

Function: parse-css (css)
Package

lquery.

Source

toolkit.lisp.

Function: replace-vector (vector function)
Package

lquery.

Source

toolkit.lisp.

Function: replace-vector-if (vector condition &key key)
Package

lquery.

Source

toolkit.lisp.

Function: set-css-styles (node css-styles)
Package

lquery.

Source

toolkit.lisp.

Function: symb (&rest args)

Interns the mkstr output/returns as symbol.

Package

lquery.

Source

toolkit.lisp.

Function: trim (string &optional chars)
Package

lquery.

Source

toolkit.lisp.


5.2.3 Generic functions

Generic Function: determine-argument (arg nodes)

Determines what to do with a given argument at compile-time (static type).

Package

lquery.

Source

lquery.lisp.

Methods
Method: determine-argument ((string string) nodes)
Method: determine-argument ((symbol symbol) nodes)
Method: determine-argument ((list list) nodes)
Generic Function: determine-value (symbol nodes)

Determines what to do with a given symbol at run-time (variable type).

Package

lquery.

Source

lquery.lisp.

Methods
Method: determine-value ((function function) nodes)
Method: determine-value ((node node) nodes)
Method: determine-value ((selector string) nodes)
Method: determine-value ((vector vector) nodes)
Method: determine-value ((array array) nodes)
Method: determine-value ((list list) nodes)
Method: determine-value (variable nodes)

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   $   %  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

$
$: Public macros
$: Public ordinary functions
$1: Public macros
$1: Public ordinary functions

%
%$: Private ordinary functions

A
add: Public ordinary functions
add-class: Public ordinary functions
after: Public ordinary functions
ancestor: Public ordinary functions
append: Public ordinary functions
append-to: Public ordinary functions
assure-attribute: Private ordinary functions
attr: Public ordinary functions

B
before: Public ordinary functions
build-elements: Private ordinary functions

C
child-index: Public ordinary functions
children: Public ordinary functions
classes: Private ordinary functions
clone: Public ordinary functions
closest: Public ordinary functions
combine: Public ordinary functions
contains: Public ordinary functions
contents: Public ordinary functions
copy-proper-vector: Public ordinary functions
css: Public ordinary functions

D
data: Public ordinary functions
deepest: Public ordinary functions
define-argument-handler: Public macros
define-lquery-function: Public macros
define-lquery-list-function: Public macros
define-lquery-macro: Public macros
define-lquery-subroutine: Public macros
define-value-handler: Public macros
deflqfun: Private macros
detach: Public ordinary functions
determine-argument: Private generic functions
determine-argument: Private generic functions
determine-argument: Private generic functions
determine-argument: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions
determine-value: Private generic functions

E
each: Public ordinary functions
empty: Public ordinary functions
empty-p: Public ordinary functions
ensure-proper-vector: Public ordinary functions
eq: Public ordinary functions
eval: Public ordinary functions
even: Public ordinary functions

F
filter: Public ordinary functions
find: Public ordinary functions
first: Public ordinary functions
funcs-or-select: Private ordinary functions
function: Public ordinary functions
Function, $: Public ordinary functions
Function, $1: Public ordinary functions
Function, %$: Private ordinary functions
Function, add: Public ordinary functions
Function, add-class: Public ordinary functions
Function, after: Public ordinary functions
Function, ancestor: Public ordinary functions
Function, append: Public ordinary functions
Function, append-to: Public ordinary functions
Function, assure-attribute: Private ordinary functions
Function, attr: Public ordinary functions
Function, before: Public ordinary functions
Function, build-elements: Private ordinary functions
Function, child-index: Public ordinary functions
Function, children: Public ordinary functions
Function, classes: Private ordinary functions
Function, clone: Public ordinary functions
Function, closest: Public ordinary functions
Function, combine: Public ordinary functions
Function, contains: Public ordinary functions
Function, contents: Public ordinary functions
Function, copy-proper-vector: Public ordinary functions
Function, css: Public ordinary functions
Function, data: Public ordinary functions
Function, deepest: Public ordinary functions
Function, detach: Public ordinary functions
Function, each: Public ordinary functions
Function, empty: Public ordinary functions
Function, empty-p: Public ordinary functions
Function, ensure-proper-vector: Public ordinary functions
Function, eq: Public ordinary functions
Function, eval: Public ordinary functions
Function, even: Public ordinary functions
Function, filter: Public ordinary functions
Function, find: Public ordinary functions
Function, first: Public ordinary functions
Function, funcs-or-select: Private ordinary functions
Function, function: Public ordinary functions
Function, get-css-styles: Private ordinary functions
Function, gt: Public ordinary functions
Function, has: Public ordinary functions
Function, has-class: Public ordinary functions
Function, hide: Public ordinary functions
Function, html: Public ordinary functions
Function, html-file: Public ordinary functions
Function, index: Public ordinary functions
Function, initialize: Public ordinary functions
Function, initialize: Public ordinary functions
Function, initialize: Public ordinary functions
Function, inline: Public ordinary functions
Function, insert-after: Public ordinary functions
Function, insert-before: Public ordinary functions
Function, is: Public ordinary functions
Function, is-empty: Public ordinary functions
Function, last: Public ordinary functions
Function, length: Public ordinary functions
Function, load-page: Public ordinary functions
Function, lt: Public ordinary functions
Function, make-proper-vector: Public ordinary functions
Function, map: Public ordinary functions
Function, map-apply: Public ordinary functions
Function, mkstr: Private ordinary functions
Function, next: Public ordinary functions
Function, next-all: Public ordinary functions
Function, next-until: Public ordinary functions
Function, node: Public ordinary functions
Function, nodes-or-build: Private ordinary functions
Function, nodes-or-select: Private ordinary functions
Function, nodes-or-selector-func: Private ordinary functions
Function, not: Public ordinary functions
Function, not-empty: Public ordinary functions
Function, odd: Public ordinary functions
Function, parent: Public ordinary functions
Function, parent-lists: Private ordinary functions
Function, parents: Public ordinary functions
Function, parents-until: Public ordinary functions
Function, parse-css: Private ordinary functions
Function, parse-html: Public ordinary functions
Function, prepend: Public ordinary functions
Function, prepend-to: Public ordinary functions
Function, prev: Public ordinary functions
Function, prev-all: Public ordinary functions
Function, prev-until: Public ordinary functions
Function, remove: Public ordinary functions
Function, remove-attr: Public ordinary functions
Function, remove-class: Public ordinary functions
Function, remove-data: Public ordinary functions
Function, render-text: Public ordinary functions
Function, replace-all: Public ordinary functions
Function, replace-vector: Private ordinary functions
Function, replace-vector-if: Private ordinary functions
Function, replace-with: Public ordinary functions
Function, root: Public ordinary functions
Function, serialize: Public ordinary functions
Function, set-css-styles: Private ordinary functions
Function, show: Public ordinary functions
Function, siblings: Public ordinary functions
Function, size: Public ordinary functions
Function, slice: Public ordinary functions
Function, splice: Public ordinary functions
Function, symb: Private ordinary functions
Function, text: Public ordinary functions
Function, toggle-class: Public ordinary functions
Function, trim: Private ordinary functions
Function, unwrap: Public ordinary functions
Function, val: Public ordinary functions
Function, wrap: Public ordinary functions
Function, wrap-all: Public ordinary functions
Function, wrap-inner: Public ordinary functions
Function, write-to-file: Public ordinary functions

G
Generic Function, determine-argument: Private generic functions
Generic Function, determine-value: Private generic functions
get-css-styles: Private ordinary functions
gt: Public ordinary functions

H
has: Public ordinary functions
has-class: Public ordinary functions
hide: Public ordinary functions
html: Public ordinary functions
html-file: Public ordinary functions

I
index: Public ordinary functions
initialize: Public ordinary functions
initialize: Public ordinary functions
initialize: Public ordinary functions
inline: Public ordinary functions
insert-after: Public ordinary functions
insert-before: Public ordinary functions
is: Public ordinary functions
is-empty: Public ordinary functions

L
last: Public ordinary functions
length: Public ordinary functions
load-page: Public ordinary functions
lt: Public ordinary functions

M
Macro, $: Public macros
Macro, $1: Public macros
Macro, define-argument-handler: Public macros
Macro, define-lquery-function: Public macros
Macro, define-lquery-list-function: Public macros
Macro, define-lquery-macro: Public macros
Macro, define-lquery-subroutine: Public macros
Macro, define-value-handler: Public macros
Macro, deflqfun: Private macros
Macro, with-master-document: Public macros
make-proper-vector: Public ordinary functions
map: Public ordinary functions
map-apply: Public ordinary functions
Method, determine-argument: Private generic functions
Method, determine-argument: Private generic functions
Method, determine-argument: Private generic functions
Method, determine-value: Private generic functions
Method, determine-value: Private generic functions
Method, determine-value: Private generic functions
Method, determine-value: Private generic functions
Method, determine-value: Private generic functions
Method, determine-value: Private generic functions
Method, determine-value: Private generic functions
mkstr: Private ordinary functions

N
next: Public ordinary functions
next-all: Public ordinary functions
next-until: Public ordinary functions
node: Public ordinary functions
nodes-or-build: Private ordinary functions
nodes-or-select: Private ordinary functions
nodes-or-selector-func: Private ordinary functions
not: Public ordinary functions
not-empty: Public ordinary functions

O
odd: Public ordinary functions

P
parent: Public ordinary functions
parent-lists: Private ordinary functions
parents: Public ordinary functions
parents-until: Public ordinary functions
parse-css: Private ordinary functions
parse-html: Public ordinary functions
prepend: Public ordinary functions
prepend-to: Public ordinary functions
prev: Public ordinary functions
prev-all: Public ordinary functions
prev-until: Public ordinary functions

R
remove: Public ordinary functions
remove-attr: Public ordinary functions
remove-class: Public ordinary functions
remove-data: Public ordinary functions
render-text: Public ordinary functions
replace-all: Public ordinary functions
replace-vector: Private ordinary functions
replace-vector-if: Private ordinary functions
replace-with: Public ordinary functions
root: Public ordinary functions

S
serialize: Public ordinary functions
set-css-styles: Private ordinary functions
show: Public ordinary functions
siblings: Public ordinary functions
size: Public ordinary functions
slice: Public ordinary functions
splice: Public ordinary functions
symb: Private ordinary functions

T
text: Public ordinary functions
toggle-class: Public ordinary functions
trim: Private ordinary functions

U
unwrap: Public ordinary functions

V
val: Public ordinary functions

W
with-master-document: Public macros
wrap: Public ordinary functions
wrap-all: Public ordinary functions
wrap-inner: Public ordinary functions
write-to-file: Public ordinary functions


A.3 Variables