The cl-mechanize Reference Manual

This is the cl-mechanize Reference Manual, version 0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:14:09 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-mechanize

A WWW::Mechanize work-alike

Author

Joachim Fasting <>

License

BSD

Version

0.0

Dependencies
  • puri (system).
  • drakma (system).
  • closure-html (system).
  • cxml-stp (system).
  • cl-ppcre (system).
Source

cl-mechanize.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 cl-mechanize/cl-mechanize.asd

Source

cl-mechanize.asd.

Parent Component

cl-mechanize (system).

ASDF Systems

cl-mechanize.

Packages

cl-mechanize-asd.


3.1.2 cl-mechanize/packages.lisp

Source

cl-mechanize.asd.

Parent Component

cl-mechanize (system).

Packages

3.1.3 cl-mechanize/cl-mechanize.lisp

Dependency

packages.lisp (file).

Source

cl-mechanize.asd.

Parent Component

cl-mechanize (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-mechanize-asd

Source

cl-mechanize.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 cl-mechanize

Source

packages.lisp.

Nicknames
  • browser
  • mechanize
  • net.browser
Use List

common-lisp.

Used By List

cl-mechanize-user.

Public Interface
Internals

4.3 cl-mechanize-user

Source

packages.lisp.

Nicknames
  • browser-user
  • mechanize-user
  • net.browser-user
Use List

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: *accept-cookies-p*

Accept cookies from visited sites?

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Special Variable: *cookie-jar-dir*

Folder where cookies are stored.
Set to NIL to disable storing/loading cookies to/from disk.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Special Variable: *cookie-lifetime-policy*

How long to keep cookies.

Setting to :EXPIRY keeps cookies until they expire

Setting to :SESSION does not store any cookies.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Special Variable: *user-agent*

Default User-Agent string.

Package

cl-mechanize.

Source

cl-mechanize.lisp.


5.1.2 Ordinary functions

Function: back (browser)

Go back in history.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Function: fetch (uri browser &key method parameters)

Send a request and fetch the response.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Function: follow (link browser)

Follow a link on the current page.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Function: reload (browser)

Repeat the current request.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Function: submit (form browser)

Submit a form on the current page.

Package

cl-mechanize.

Source

cl-mechanize.lisp.


5.1.3 Generic functions

Generic Reader: browser-cookie-jar (object)
Generic Writer: (setf browser-cookie-jar) (object)
Package

cl-mechanize.

Methods
Reader Method: browser-cookie-jar ((browser browser))
Writer Method: (setf browser-cookie-jar) ((browser browser))

The current cookie jar object. Updated by FETCH.

Source

cl-mechanize.lisp.

Target Slot

cookie-jar.

Generic Reader: browser-history (object)
Generic Writer: (setf browser-history) (object)
Package

cl-mechanize.

Methods
Reader Method: browser-history ((browser browser))
Writer Method: (setf browser-history) ((browser browser))

A list of visited pages, in chronological order.

Source

cl-mechanize.lisp.

Target Slot

history.

Generic Reader: browser-page (object)
Generic Writer: (setf browser-page) (object)
Package

cl-mechanize.

Methods
Reader Method: browser-page ((browser browser))
Writer Method: (setf browser-page) ((browser browser))

The current page object. Updated by FETCH.

Source

cl-mechanize.lisp.

Target Slot

page.

Generic Reader: browser-user-agent (object)
Generic Writer: (setf browser-user-agent) (object)
Package

cl-mechanize.

Methods
Reader Method: browser-user-agent ((browser browser))
Writer Method: (setf browser-user-agent) ((browser browser))

User-Agent string used by GET.

Source

cl-mechanize.lisp.

Target Slot

user-agent.

Generic Reader: form-action (object)
Package

cl-mechanize.

Methods
Reader Method: form-action ((form form))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

action.

Generic Writer: (setf form-action) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf form-action) ((form form))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

action.

Generic Reader: form-inputs (object)
Package

cl-mechanize.

Methods
Reader Method: form-inputs ((form form))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

inputs.

Generic Writer: (setf form-inputs) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf form-inputs) ((form form))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

inputs.

Generic Reader: form-method (object)
Package

cl-mechanize.

Methods
Reader Method: form-method ((form form))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

method.

Generic Writer: (setf form-method) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf form-method) ((form form))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

method.

Generic Reader: form-name (object)
Package

cl-mechanize.

Methods
Reader Method: form-name ((form form))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

name.

Generic Writer: (setf form-name) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf form-name) ((form form))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

name.

Package

cl-mechanize.

Methods

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

attrs.

Package

cl-mechanize.

Methods

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

attrs.

Package

cl-mechanize.

Methods

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

tag.

Package

cl-mechanize.

Methods

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

tag.

Package

cl-mechanize.

Methods

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

text.

Package

cl-mechanize.

Methods

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

text.

Package

cl-mechanize.

Methods

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

uri.

Package

cl-mechanize.

Methods

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

uri.

Package

cl-mechanize.

Methods

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

url.

Package

cl-mechanize.

Methods

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

url.

Generic Reader: page-content (object)
Package

cl-mechanize.

Methods
Reader Method: page-content ((page page))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

content.

Generic Writer: (setf page-content) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf page-content) ((page page))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

content.

Generic Reader: page-dom (object)
Package

cl-mechanize.

Methods
Reader Method: page-dom ((page page))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

dom.

Generic Writer: (setf page-dom) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf page-dom) ((page page))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

dom.

Generic Reader: page-forms (object)
Package

cl-mechanize.

Methods
Reader Method: page-forms ((page page))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

forms.

Generic Writer: (setf page-forms) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf page-forms) ((page page))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

forms.

Package

cl-mechanize.

Methods

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

links.

Package

cl-mechanize.

Methods

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

links.

Generic Reader: page-uri (object)
Package

cl-mechanize.

Methods
Reader Method: page-uri ((page page))

automatically generated reader method

Source

cl-mechanize.lisp.

Target Slot

uri.

Generic Writer: (setf page-uri) (object)
Package

cl-mechanize.

Methods
Writer Method: (setf page-uri) ((page page))

automatically generated writer method

Source

cl-mechanize.lisp.

Target Slot

uri.


5.1.4 Classes

Class: browser

Encapsulates the browser state.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Direct methods
Direct slots
Slot: user-agent

User-Agent string used by GET.

Initform

cl-mechanize:*user-agent*

Initargs

:user-agent

Readers

browser-user-agent.

Writers

(setf browser-user-agent).

The current cookie jar object. Updated by FETCH.

Initform

(make-instance (quote drakma:cookie-jar))

Readers

browser-cookie-jar.

Writers

(setf browser-cookie-jar).

Slot: history

A list of visited pages, in chronological order.

Readers

browser-history.

Writers

(setf browser-history).

Slot: page

The current page object. Updated by FETCH.

Readers

browser-page.

Writers

(setf browser-page).

Slot: status

The HTTP status code of the last request.

Readers

browser-status.

Writers

(setf browser-status).

Class: form

Represents a form element.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

form-name.

Writers

(setf form-name).

Slot: action
Initargs

:action

Readers

form-action.

Writers

(setf form-action).

Slot: method
Package

common-lisp.

Initform

:get

Initargs

:method

Readers

form-method.

Writers

(setf form-method).

Slot: inputs
Initargs

:inputs

Readers

form-inputs.

Writers

(setf form-inputs).

Represents a link element.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Direct methods
Direct slots
Slot: text
Initargs

:text

Readers

link-text.

Writers

(setf link-text).

Slot: uri
Initargs

:uri

Readers

link-uri.

Writers

(setf link-uri).

Slot: url
Initargs

:url

Readers

link-url.

Writers

(setf link-url).

Slot: tag
Initform

:a

Initargs

:tag

Readers

link-tag.

Writers

(setf link-tag).

Slot: attrs
Initargs

:attrs

Readers

link-attrs.

Writers

(setf link-attrs).

Class: page

Contains the result of fetching a page.

Package

cl-mechanize.

Source

cl-mechanize.lisp.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

page-uri.

Writers

(setf page-uri).

Initargs

:links

Readers

page-links.

Writers

(setf page-links).

Slot: forms
Initargs

:forms

Readers

page-forms.

Writers

(setf page-forms).

Slot: dom
Initargs

:dom

Readers

page-dom.

Writers

(setf page-dom).

Slot: content
Initargs

:content

Readers

page-content.

Writers

(setf page-content).


5.2 Internals


5.2.1 Generic functions

Generic Reader: browser-status (object)
Generic Writer: (setf browser-status) (object)
Package

cl-mechanize.

Methods
Reader Method: browser-status ((browser browser))
Writer Method: (setf browser-status) ((browser browser))

The HTTP status code of the last request.

Source

cl-mechanize.lisp.

Target Slot

status.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   F   G   L   M   P   R   S  
Index Entry  Section

(
(setf browser-cookie-jar): Public generic functions
(setf browser-cookie-jar): Public generic functions
(setf browser-history): Public generic functions
(setf browser-history): Public generic functions
(setf browser-page): Public generic functions
(setf browser-page): Public generic functions
(setf browser-status): Private generic functions
(setf browser-status): Private generic functions
(setf browser-user-agent): Public generic functions
(setf browser-user-agent): Public generic functions
(setf form-action): Public generic functions
(setf form-action): Public generic functions
(setf form-inputs): Public generic functions
(setf form-inputs): Public generic functions
(setf form-method): Public generic functions
(setf form-method): Public generic functions
(setf form-name): Public generic functions
(setf form-name): Public generic functions
(setf link-attrs): Public generic functions
(setf link-attrs): Public generic functions
(setf link-tag): Public generic functions
(setf link-tag): Public generic functions
(setf link-text): Public generic functions
(setf link-text): Public generic functions
(setf link-uri): Public generic functions
(setf link-uri): Public generic functions
(setf link-url): Public generic functions
(setf link-url): Public generic functions
(setf page-content): Public generic functions
(setf page-content): Public generic functions
(setf page-dom): Public generic functions
(setf page-dom): Public generic functions
(setf page-forms): Public generic functions
(setf page-forms): Public generic functions
(setf page-links): Public generic functions
(setf page-links): Public generic functions
(setf page-uri): Public generic functions
(setf page-uri): Public generic functions

B
back: Public ordinary functions
browser-cookie-jar: Public generic functions
browser-cookie-jar: Public generic functions
browser-history: Public generic functions
browser-history: Public generic functions
browser-page: Public generic functions
browser-page: Public generic functions
browser-status: Private generic functions
browser-status: Private generic functions
browser-user-agent: Public generic functions
browser-user-agent: Public generic functions

F
fetch: Public ordinary functions
follow: Public ordinary functions
form-action: Public generic functions
form-action: Public generic functions
form-inputs: Public generic functions
form-inputs: Public generic functions
form-method: Public generic functions
form-method: Public generic functions
form-name: Public generic functions
form-name: Public generic functions
Function, back: Public ordinary functions
Function, fetch: Public ordinary functions
Function, follow: Public ordinary functions
Function, reload: Public ordinary functions
Function, submit: Public ordinary functions

G
Generic Function, (setf browser-cookie-jar): Public generic functions
Generic Function, (setf browser-history): Public generic functions
Generic Function, (setf browser-page): Public generic functions
Generic Function, (setf browser-status): Private generic functions
Generic Function, (setf browser-user-agent): Public generic functions
Generic Function, (setf form-action): Public generic functions
Generic Function, (setf form-inputs): Public generic functions
Generic Function, (setf form-method): Public generic functions
Generic Function, (setf form-name): Public generic functions
Generic Function, (setf link-attrs): Public generic functions
Generic Function, (setf link-tag): Public generic functions
Generic Function, (setf link-text): Public generic functions
Generic Function, (setf link-uri): Public generic functions
Generic Function, (setf link-url): Public generic functions
Generic Function, (setf page-content): Public generic functions
Generic Function, (setf page-dom): Public generic functions
Generic Function, (setf page-forms): Public generic functions
Generic Function, (setf page-links): Public generic functions
Generic Function, (setf page-uri): Public generic functions
Generic Function, browser-cookie-jar: Public generic functions
Generic Function, browser-history: Public generic functions
Generic Function, browser-page: Public generic functions
Generic Function, browser-status: Private generic functions
Generic Function, browser-user-agent: Public generic functions
Generic Function, form-action: Public generic functions
Generic Function, form-inputs: Public generic functions
Generic Function, form-method: Public generic functions
Generic Function, form-name: Public generic functions
Generic Function, link-attrs: Public generic functions
Generic Function, link-tag: Public generic functions
Generic Function, link-text: Public generic functions
Generic Function, link-uri: Public generic functions
Generic Function, link-url: Public generic functions
Generic Function, page-content: Public generic functions
Generic Function, page-dom: Public generic functions
Generic Function, page-forms: Public generic functions
Generic Function, page-links: Public generic functions
Generic Function, page-uri: Public generic functions

L
link-attrs: Public generic functions
link-attrs: Public generic functions
link-tag: Public generic functions
link-tag: Public generic functions
link-text: Public generic functions
link-text: Public generic functions
link-uri: Public generic functions
link-uri: Public generic functions
link-url: Public generic functions
link-url: Public generic functions

M
Method, (setf browser-cookie-jar): Public generic functions
Method, (setf browser-history): Public generic functions
Method, (setf browser-page): Public generic functions
Method, (setf browser-status): Private generic functions
Method, (setf browser-user-agent): Public generic functions
Method, (setf form-action): Public generic functions
Method, (setf form-inputs): Public generic functions
Method, (setf form-method): Public generic functions
Method, (setf form-name): Public generic functions
Method, (setf link-attrs): Public generic functions
Method, (setf link-tag): Public generic functions
Method, (setf link-text): Public generic functions
Method, (setf link-uri): Public generic functions
Method, (setf link-url): Public generic functions
Method, (setf page-content): Public generic functions
Method, (setf page-dom): Public generic functions
Method, (setf page-forms): Public generic functions
Method, (setf page-links): Public generic functions
Method, (setf page-uri): Public generic functions
Method, browser-cookie-jar: Public generic functions
Method, browser-history: Public generic functions
Method, browser-page: Public generic functions
Method, browser-status: Private generic functions
Method, browser-user-agent: Public generic functions
Method, form-action: Public generic functions
Method, form-inputs: Public generic functions
Method, form-method: Public generic functions
Method, form-name: Public generic functions
Method, link-attrs: Public generic functions
Method, link-tag: Public generic functions
Method, link-text: Public generic functions
Method, link-uri: Public generic functions
Method, link-url: Public generic functions
Method, page-content: Public generic functions
Method, page-dom: Public generic functions
Method, page-forms: Public generic functions
Method, page-links: Public generic functions
Method, page-uri: Public generic functions

P
page-content: Public generic functions
page-content: Public generic functions
page-dom: Public generic functions
page-dom: Public generic functions
page-forms: Public generic functions
page-forms: Public generic functions
page-links: Public generic functions
page-links: Public generic functions
page-uri: Public generic functions
page-uri: Public generic functions

R
reload: Public ordinary functions

S
submit: Public ordinary functions


A.3 Variables

Jump to:   *  
A   C   D   F   H   I   L   M   N   P   S   T   U  
Index Entry  Section

*
*accept-cookies-p*: Public special variables
*cookie-jar-dir*: Public special variables
*cookie-lifetime-policy*: Public special variables
*user-agent*: Public special variables

A
action: Public classes
attrs: Public classes

C
content: Public classes
cookie-jar: Public classes

D
dom: Public classes

F
forms: Public classes

H
history: Public classes

I
inputs: Public classes

L
links: Public classes

M
method: Public classes

N
name: Public classes

P
page: Public classes

S
Slot, action: Public classes
Slot, attrs: Public classes
Slot, content: Public classes
Slot, cookie-jar: Public classes
Slot, dom: Public classes
Slot, forms: Public classes
Slot, history: Public classes
Slot, inputs: Public classes
Slot, links: Public classes
Slot, method: Public classes
Slot, name: Public classes
Slot, page: Public classes
Slot, status: Public classes
Slot, tag: Public classes
Slot, text: Public classes
Slot, uri: Public classes
Slot, uri: Public classes
Slot, url: Public classes
Slot, user-agent: Public classes
Special Variable, *accept-cookies-p*: Public special variables
Special Variable, *cookie-jar-dir*: Public special variables
Special Variable, *cookie-lifetime-policy*: Public special variables
Special Variable, *user-agent*: Public special variables
status: Public classes

T
tag: Public classes
text: Public classes

U
uri: Public classes
uri: Public classes
url: Public classes
user-agent: Public classes