The cl-selenium Reference Manual

This is the cl-selenium Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:42:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-selenium

cl-selenim-webdriver is a binding library to the Selenium 2.0

Author

TatriX <>

License

MIT

Dependencies
  • dexador (system).
  • quri (system).
  • cl-json (system).
  • alexandria (system).
  • split-sequence (system).
Source

cl-selenium.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-selenium/src

Source

cl-selenium.asd.

Parent Component

cl-selenium (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-selenium/cl-selenium.asd

Source

cl-selenium.asd.

Parent Component

cl-selenium (system).

ASDF Systems

cl-selenium.


4.1.2 cl-selenium/src/package.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Packages

4.1.3 cl-selenium/src/errors.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 cl-selenium/src/session.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 cl-selenium/src/keys.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Public Interface

key (function).

Internals

*keymap* (special variable).


4.1.6 cl-selenium/src/mouse.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Public Interface

4.1.7 cl-selenium/src/http.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Internals

4.1.8 cl-selenium/src/selenium.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.9 cl-selenium/src/utils.lisp

Source

cl-selenium.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 cl-selenium

Source

package.lisp.

Use List

common-lisp.

Used By List

cl-selenium-utils.

Public Interface
Internals

5.2 cl-selenium-utils

Source

package.lisp.

Use List
Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *default-element-func*
Package

cl-selenium-utils.

Source

utils.lisp.

Special Variable: *timeout*
Package

cl-selenium-utils.

Source

utils.lisp.


6.1.2 Macros

Macro: with-session ((&rest capabilities) &body body)
Package

cl-selenium.

Source

session.lisp.


6.1.3 Ordinary functions

Function: active-element (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: attr (name &optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: back (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: classlist (&optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: classname (&optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: click (&optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: close-current-window (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Package

cl-selenium.

Source

selenium.lisp.

Package

cl-selenium.

Source

selenium.lisp.

Function: delete-session (session)
Package

cl-selenium.

Source

session.lisp.

Function: elem (&optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: element-attribute (element name &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-clear (element &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-click (element &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-displayed (element &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-location (element &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-send-keys (element keys &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-tagname (element &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: element-text (element &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: execute-script (script args &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: find-elem (selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: find-element (value &key by session)
Package

cl-selenium.

Source

selenium.lisp.

Function: find-elements (value &key by session)
Package

cl-selenium.

Source

selenium.lisp.

Function: get-cookie (cookie name)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: id (&optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: key (key)
Package

cl-selenium.

Source

keys.lisp.

Function: log-types (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: logs (type &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: make-cookie (name value &key path domain secure expiry)
Package

cl-selenium.

Source

selenium.lisp.

Function: make-session (&key browser-name browser-version platform-name platform-version accept-ssl-certs additional-capabilities)
Package

cl-selenium.

Source

session.lisp.

Function: mouse-click (button &key session)
Package

cl-selenium.

Source

mouse.lisp.

Function: mouse-move-to (x y &key element session)
Package

cl-selenium.

Source

mouse.lisp.

Function: refresh (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: screenshot (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: send-key (key &optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: send-keys (keys &optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: start-interactive-session (&rest capabilities)
Package

cl-selenium.

Source

session.lisp.

Function: stop-interactive-session ()
Package

cl-selenium.

Source

session.lisp.

Function: switch-to-frame (id &key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: text (&optional selector)
Package

cl-selenium-utils.

Source

utils.lisp.

Function: url (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: (setf url) (&key session)
Package

cl-selenium.

Source

selenium.lisp.

Function: use-session (session)
Package

cl-selenium.

Source

session.lisp.

Function: wait-for (selector &key timeout)
Package

cl-selenium-utils.

Source

utils.lisp.


6.1.4 Generic functions

Generic Reader: element-id (object)
Package

cl-selenium.

Methods
Reader Method: element-id ((element element))

automatically generated reader method

Source

selenium.lisp.

Target Slot

id.


6.1.5 Standalone methods

Method: print-object ((element element) stream)
Source

selenium.lisp.

Method: print-object ((error protocol-error) stream)
Source

errors.lisp.


6.1.6 Conditions

Condition: no-such-element-error
Package

cl-selenium.

Source

errors.lisp.

Direct superclasses

find-error.


6.1.7 Classes

Package

cl-selenium.

Source

selenium.lisp.

Direct slots
Slot: name
Initargs

:name

Slot: value
Initargs

:value

Slot: path
Initargs

:path

Slot: domain
Initargs

:domain

Slot: secure
Initargs

:secure

Slot: expiry
Initargs

:expiry


6.2 Internals


6.2.1 Special variables

Special Variable: *keymap*
Package

cl-selenium.

Source

keys.lisp.

Special Variable: *prefix*
Package

cl-selenium.

Source

http.lisp.

Special Variable: *session*
Package

cl-selenium.

Source

session.lisp.

Special Variable: *uri*
Package

cl-selenium.

Source

http.lisp.


6.2.2 Macros

Macro: with-decode-and-handler (body)
Package

cl-selenium.

Source

http.lisp.


6.2.3 Ordinary functions

Function: by (type)
Package

cl-selenium.

Source

selenium.lisp.

Function: check (response)
Package

cl-selenium.

Source

http.lisp.

Function: decode (json)
Package

cl-selenium.

Source

http.lisp.

Function: encode (plist)
Package

cl-selenium.

Source

http.lisp.

Function: handle-find-error (err &key value by)
Package

cl-selenium.

Source

selenium.lisp.

Function: http-delete (path)
Package

cl-selenium.

Source

http.lisp.

Function: http-delete-check (path)
Package

cl-selenium.

Source

http.lisp.

Function: http-get (path)
Package

cl-selenium.

Source

http.lisp.

Function: http-get-check (path)
Package

cl-selenium.

Source

http.lisp.

Function: http-get-value (path)
Package

cl-selenium.

Source

http.lisp.

Function: http-post (path &optional params)
Package

cl-selenium.

Source

http.lisp.

Function: http-post-check (path &rest params)
Package

cl-selenium.

Source

http.lisp.

Function: http-post-value (path &rest params)
Package

cl-selenium.

Source

http.lisp.

Function: make-uri (path)
Package

cl-selenium.

Source

http.lisp.

Function: protocol-error-status (error)
Package

cl-selenium.

Source

errors.lisp.

Function: session-path (session fmt &rest args)
Package

cl-selenium.

Source

session.lisp.

Function: value (response)
Package

cl-selenium.

Source

http.lisp.


6.2.4 Generic functions

Generic Reader: protocol-error-body (condition)
Package

cl-selenium.

Methods
Reader Method: protocol-error-body ((condition protocol-error))
Source

errors.lisp.

Target Slot

body.

Generic Reader: session-id (object)
Package

cl-selenium.

Methods
Reader Method: session-id ((session session))

automatically generated reader method

Source

session.lisp.

Target Slot

id.


6.2.5 Conditions

Condition: find-error
Package

cl-selenium.

Source

errors.lisp.

Direct superclasses

error.

Direct subclasses
Direct slots
Slot: value
Initargs

:value

Slot: by
Initargs

:by

Condition: protocol-error
Package

cl-selenium.

Source

errors.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: body
Initargs

:body

Readers

protocol-error-body.

Writers

This slot is read-only.

Condition: stale-element-reference
Package

cl-selenium.

Source

errors.lisp.

Direct superclasses

find-error.


6.2.6 Classes

Class: element
Package

cl-selenium.

Source

selenium.lisp.

Direct methods
Direct slots
Slot: id
Initform

(error "must supply :id")

Initargs

:id

Readers

element-id.

Writers

This slot is read-only.

Class: session
Package

cl-selenium.

Source

session.lisp.

Direct methods

session-id.

Direct slots
Slot: id
Initform

(error "must supply an id")

Initargs

:id

Readers

session-id.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

(
(setf cookie): Public ordinary functions
(setf url): Public ordinary functions

A
active-element: Public ordinary functions
attr: Public ordinary functions

B
back: Public ordinary functions
by: Private ordinary functions

C
check: Private ordinary functions
classlist: Public ordinary functions
classname: Public ordinary functions
click: Public ordinary functions
close-current-window: Public ordinary functions
cookie: Public ordinary functions

D
decode: Private ordinary functions
delete-session: Public ordinary functions

E
elem: Public ordinary functions
element-attribute: Public ordinary functions
element-clear: Public ordinary functions
element-click: Public ordinary functions
element-displayed: Public ordinary functions
element-id: Public generic functions
element-id: Public generic functions
element-location: Public ordinary functions
element-send-keys: Public ordinary functions
element-tagname: Public ordinary functions
element-text: Public ordinary functions
encode: Private ordinary functions
execute-script: Public ordinary functions

F
find-elem: Public ordinary functions
find-element: Public ordinary functions
find-elements: Public ordinary functions
Function, (setf cookie): Public ordinary functions
Function, (setf url): Public ordinary functions
Function, active-element: Public ordinary functions
Function, attr: Public ordinary functions
Function, back: Public ordinary functions
Function, by: Private ordinary functions
Function, check: Private ordinary functions
Function, classlist: Public ordinary functions
Function, classname: Public ordinary functions
Function, click: Public ordinary functions
Function, close-current-window: Public ordinary functions
Function, cookie: Public ordinary functions
Function, decode: Private ordinary functions
Function, delete-session: Public ordinary functions
Function, elem: Public ordinary functions
Function, element-attribute: Public ordinary functions
Function, element-clear: Public ordinary functions
Function, element-click: Public ordinary functions
Function, element-displayed: Public ordinary functions
Function, element-location: Public ordinary functions
Function, element-send-keys: Public ordinary functions
Function, element-tagname: Public ordinary functions
Function, element-text: Public ordinary functions
Function, encode: Private ordinary functions
Function, execute-script: Public ordinary functions
Function, find-elem: Public ordinary functions
Function, find-element: Public ordinary functions
Function, find-elements: Public ordinary functions
Function, get-cookie: Public ordinary functions
Function, handle-find-error: Private ordinary functions
Function, http-delete: Private ordinary functions
Function, http-delete-check: Private ordinary functions
Function, http-get: Private ordinary functions
Function, http-get-check: Private ordinary functions
Function, http-get-value: Private ordinary functions
Function, http-post: Private ordinary functions
Function, http-post-check: Private ordinary functions
Function, http-post-value: Private ordinary functions
Function, id: Public ordinary functions
Function, key: Public ordinary functions
Function, log-types: Public ordinary functions
Function, logs: Public ordinary functions
Function, make-cookie: Public ordinary functions
Function, make-session: Public ordinary functions
Function, make-uri: Private ordinary functions
Function, mouse-click: Public ordinary functions
Function, mouse-move-to: Public ordinary functions
Function, protocol-error-status: Private ordinary functions
Function, refresh: Public ordinary functions
Function, screenshot: Public ordinary functions
Function, send-key: Public ordinary functions
Function, send-keys: Public ordinary functions
Function, session-path: Private ordinary functions
Function, start-interactive-session: Public ordinary functions
Function, stop-interactive-session: Public ordinary functions
Function, switch-to-frame: Public ordinary functions
Function, text: Public ordinary functions
Function, url: Public ordinary functions
Function, use-session: Public ordinary functions
Function, value: Private ordinary functions
Function, wait-for: Public ordinary functions

G
Generic Function, element-id: Public generic functions
Generic Function, protocol-error-body: Private generic functions
Generic Function, session-id: Private generic functions
get-cookie: Public ordinary functions

H
handle-find-error: Private ordinary functions
http-delete: Private ordinary functions
http-delete-check: Private ordinary functions
http-get: Private ordinary functions
http-get-check: Private ordinary functions
http-get-value: Private ordinary functions
http-post: Private ordinary functions
http-post-check: Private ordinary functions
http-post-value: Private ordinary functions

I
id: Public ordinary functions

K
key: Public ordinary functions

L
log-types: Public ordinary functions
logs: Public ordinary functions

M
Macro, with-decode-and-handler: Private macros
Macro, with-session: Public macros
make-cookie: Public ordinary functions
make-session: Public ordinary functions
make-uri: Private ordinary functions
Method, element-id: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, protocol-error-body: Private generic functions
Method, session-id: Private generic functions
mouse-click: Public ordinary functions
mouse-move-to: Public ordinary functions

P
print-object: Public standalone methods
print-object: Public standalone methods
protocol-error-body: Private generic functions
protocol-error-body: Private generic functions
protocol-error-status: Private ordinary functions

R
refresh: Public ordinary functions

S
screenshot: Public ordinary functions
send-key: Public ordinary functions
send-keys: Public ordinary functions
session-id: Private generic functions
session-id: Private generic functions
session-path: Private ordinary functions
start-interactive-session: Public ordinary functions
stop-interactive-session: Public ordinary functions
switch-to-frame: Public ordinary functions

T
text: Public ordinary functions

U
url: Public ordinary functions
use-session: Public ordinary functions

V
value: Private ordinary functions

W
wait-for: Public ordinary functions
with-decode-and-handler: Private macros
with-session: Public macros


A.4 Data types

Jump to:   C   E   F   H   K   M   N   P   S   U  
Index Entry  Section

C
cl-selenium: The cl-selenium system
cl-selenium: The cl-selenium package
cl-selenium-utils: The cl-selenium-utils package
cl-selenium.asd: The cl-selenium/cl-selenium․asd file
Class, cookie: Public classes
Class, element: Private classes
Class, session: Private classes
Condition, find-error: Private conditions
Condition, no-such-element-error: Public conditions
Condition, protocol-error: Private conditions
Condition, stale-element-reference: Private conditions
cookie: Public classes

E
element: Private classes
errors.lisp: The cl-selenium/src/errors․lisp file

F
File, cl-selenium.asd: The cl-selenium/cl-selenium․asd file
File, errors.lisp: The cl-selenium/src/errors․lisp file
File, http.lisp: The cl-selenium/src/http․lisp file
File, keys.lisp: The cl-selenium/src/keys․lisp file
File, mouse.lisp: The cl-selenium/src/mouse․lisp file
File, package.lisp: The cl-selenium/src/package․lisp file
File, selenium.lisp: The cl-selenium/src/selenium․lisp file
File, session.lisp: The cl-selenium/src/session․lisp file
File, utils.lisp: The cl-selenium/src/utils․lisp file
find-error: Private conditions

H
http.lisp: The cl-selenium/src/http․lisp file

K
keys.lisp: The cl-selenium/src/keys․lisp file

M
Module, src: The cl-selenium/src module
mouse.lisp: The cl-selenium/src/mouse․lisp file

N
no-such-element-error: Public conditions

P
Package, cl-selenium: The cl-selenium package
Package, cl-selenium-utils: The cl-selenium-utils package
package.lisp: The cl-selenium/src/package․lisp file
protocol-error: Private conditions

S
selenium.lisp: The cl-selenium/src/selenium․lisp file
session: Private classes
session.lisp: The cl-selenium/src/session․lisp file
src: The cl-selenium/src module
stale-element-reference: Private conditions
System, cl-selenium: The cl-selenium system

U
utils.lisp: The cl-selenium/src/utils․lisp file