The cl-html-parse Reference Manual

This is the cl-html-parse Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:05:59 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-html-parse

HTML Parser

Maintainer

Gary Warren King <>

Author

Gary Warren King <>

License

MIT Style license for the packaging, AllegroServe license for the code.

Long Description

Franz’s HTML Parser packaged up separately for ASDF.

Version

1.0

Source

cl-html-parse.asd.

Child Components

3 Modules

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


3.1 cl-html-parse/dev

Source

cl-html-parse.asd.

Parent Component

cl-html-parse (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-html-parse/cl-html-parse.asd

Source

cl-html-parse.asd.

Parent Component

cl-html-parse (system).

ASDF Systems

cl-html-parse.


4.1.2 cl-html-parse/dev/if-star.lisp

Source

cl-html-parse.asd.

Parent Component

dev (module).

Packages

if-star-for-cl-html-parse.

Public Interface

if* (macro).

Internals

if*-keyword-list (special variable).


4.1.3 cl-html-parse/dev/cl-html-parse.lisp

Dependency

if-star.lisp (file).

Source

cl-html-parse.asd.

Parent Component

dev (module).

Packages

net.html.parser.

Public Interface
Internals

4.2 Static


4.2.1 cl-html-parse/COPYING

Source

cl-html-parse.asd.

Parent Component

cl-html-parse (system).


4.2.2 cl-html-parse/dev/README

Source

cl-html-parse.asd.

Parent Component

dev (module).


4.2.3 cl-html-parse/dev/examples/contacts.html

Source

cl-html-parse.asd.

Parent Component

dev (module).


5 Packages

Packages are listed by definition order.


5.1 net.html.parser

Source

cl-html-parse.lisp.

Nicknames
  • html-parse
  • cl-html-parse
Use List
Public Interface
Internals

5.2 if-star-for-cl-html-parse

Source

if-star.lisp.

Use List

common-lisp.

Used By List

net.html.parser.

Public Interface

if* (macro).

Internals

if*-keyword-list (special variable).


6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: if* (&rest args)
Package

if-star-for-cl-html-parse.

Source

if-star.lisp.


6.1.2 Ordinary functions

Function: phtml-internal (p read-sequence-func callback-only callbacks collect-rogue-tags no-body-tags parse-entities)
Package

net.html.parser.

Source

cl-html-parse.lisp.


6.1.3 Generic functions

Generic Function: parse-html (p &key callback-only callbacks collect-rogue-tags no-body-tags parse-entities)
Package

net.html.parser.

Methods
Method: parse-html ((str string) &key callback-only callbacks collect-rogue-tags no-body-tags parse-entities)
Source

cl-html-parse.lisp.

Method: parse-html (file &key callback-only callbacks collect-rogue-tags no-body-tags parse-entities)
Source

cl-html-parse.lisp.

Method: parse-html ((p stream) &key callback-only callbacks collect-rogue-tags no-body-tags parse-entities)
Source

cl-html-parse.lisp.


6.2 Internals


6.2.1 Constants

Constant: char-attribnamechar
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: char-attribundelimattribvalue
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: char-spacechar
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: char-tagcharacter
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-attribname
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-attribstartvalue
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-attribvaluedelim
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-attribvaluenodelim
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-findattribname
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-findvalue
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-pcdata
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-rawdata
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-readcomment
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-readcomment-one
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-readcomment-two
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-readtag
Package

net.html.parser.

Source

cl-html-parse.lisp.

Constant: state-readtagfirst
Package

net.html.parser.

Source

cl-html-parse.lisp.


6.2.2 Special variables

Special Variable: *ch-format*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *characteristics*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *collectors*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *html-entity-to-code*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *in-line*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *known-tags*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *kwd-package*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: *tokenbufs*
Package

net.html.parser.

Source

cl-html-parse.lisp.

Special Variable: if*-keyword-list
Package

if-star-for-cl-html-parse.

Source

if-star.lisp.


6.2.3 Macros

Macro: tag-auto-close (tag)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Macro: tag-auto-close-stop (tag)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Macro: tag-callback (tag)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Macro: tag-name (expr)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Macro: tag-no-end (tag)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Macro: tag-no-pcdata (tag)
Package

net.html.parser.

Source

cl-html-parse.lisp.


6.2.4 Ordinary functions

Function: char-characteristic (char bit)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: coll-has-comment (coll)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Reader: collector-data (instance)
Writer: (setf collector-data) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

data.

Reader: collector-max (instance)
Writer: (setf collector-max) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

max.

Reader: collector-next (instance)
Writer: (setf collector-next) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

next.

Function: collector-p (object)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: compute-coll-string (coll)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: compute-tag (coll)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: copy-collector (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: copy-tokenbuf (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: current-case-mode ()
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: get-collector ()
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: get-tokenbuf ()
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: grow-and-add (coll ch)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: make-collector (&key next max data)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: make-tokenbuf (&key cur max data first-pass)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: next-token (stream ignore-strings raw-mode-delimiter read-sequence-func tokenbuf parse-entities)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: put-back-collector (col)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: put-back-tokenbuf (buf)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Function: to-preferred-case (ch)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Reader: tokenbuf-cur (instance)
Writer: (setf tokenbuf-cur) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

cur.

Reader: tokenbuf-data (instance)
Writer: (setf tokenbuf-data) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

data.

Reader: tokenbuf-first-pass (instance)
Writer: (setf tokenbuf-first-pass) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

first-pass.

Reader: tokenbuf-max (instance)
Writer: (setf tokenbuf-max) (instance)
Package

net.html.parser.

Source

cl-html-parse.lisp.

Target Slot

max.

Function: tokenbuf-p (object)
Package

net.html.parser.

Source

cl-html-parse.lisp.


6.2.5 Structures

Structure: collector
Package

net.html.parser.

Source

cl-html-parse.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: next
Readers

collector-next.

Writers

(setf collector-next).

Slot: max
Package

common-lisp.

Readers

collector-max.

Writers

(setf collector-max).

Slot: data
Readers

collector-data.

Writers

(setf collector-data).

Structure: tokenbuf
Package

net.html.parser.

Source

cl-html-parse.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: cur
Readers

tokenbuf-cur.

Writers

(setf tokenbuf-cur).

Slot: max
Package

common-lisp.

Readers

tokenbuf-max.

Writers

(setf tokenbuf-max).

Slot: data
Readers

tokenbuf-data.

Writers

(setf tokenbuf-data).

Slot: first-pass
Readers

tokenbuf-first-pass.

Writers

(setf tokenbuf-first-pass).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   F   G   I   M   N   P   T  
Index Entry  Section

(
(setf collector-data): Private ordinary functions
(setf collector-max): Private ordinary functions
(setf collector-next): Private ordinary functions
(setf tokenbuf-cur): Private ordinary functions
(setf tokenbuf-data): Private ordinary functions
(setf tokenbuf-first-pass): Private ordinary functions
(setf tokenbuf-max): Private ordinary functions

C
char-characteristic: Private ordinary functions
coll-has-comment: Private ordinary functions
collector-data: Private ordinary functions
collector-max: Private ordinary functions
collector-next: Private ordinary functions
collector-p: Private ordinary functions
compute-coll-string: Private ordinary functions
compute-tag: Private ordinary functions
copy-collector: Private ordinary functions
copy-tokenbuf: Private ordinary functions
current-case-mode: Private ordinary functions

F
Function, (setf collector-data): Private ordinary functions
Function, (setf collector-max): Private ordinary functions
Function, (setf collector-next): Private ordinary functions
Function, (setf tokenbuf-cur): Private ordinary functions
Function, (setf tokenbuf-data): Private ordinary functions
Function, (setf tokenbuf-first-pass): Private ordinary functions
Function, (setf tokenbuf-max): Private ordinary functions
Function, char-characteristic: Private ordinary functions
Function, coll-has-comment: Private ordinary functions
Function, collector-data: Private ordinary functions
Function, collector-max: Private ordinary functions
Function, collector-next: Private ordinary functions
Function, collector-p: Private ordinary functions
Function, compute-coll-string: Private ordinary functions
Function, compute-tag: Private ordinary functions
Function, copy-collector: Private ordinary functions
Function, copy-tokenbuf: Private ordinary functions
Function, current-case-mode: Private ordinary functions
Function, get-collector: Private ordinary functions
Function, get-tokenbuf: Private ordinary functions
Function, grow-and-add: Private ordinary functions
Function, make-collector: Private ordinary functions
Function, make-tokenbuf: Private ordinary functions
Function, next-token: Private ordinary functions
Function, phtml-internal: Public ordinary functions
Function, put-back-collector: Private ordinary functions
Function, put-back-tokenbuf: Private ordinary functions
Function, to-preferred-case: Private ordinary functions
Function, tokenbuf-cur: Private ordinary functions
Function, tokenbuf-data: Private ordinary functions
Function, tokenbuf-first-pass: Private ordinary functions
Function, tokenbuf-max: Private ordinary functions
Function, tokenbuf-p: Private ordinary functions

G
Generic Function, parse-html: Public generic functions
get-collector: Private ordinary functions
get-tokenbuf: Private ordinary functions
grow-and-add: Private ordinary functions

I
if*: Public macros

M
Macro, if*: Public macros
Macro, tag-auto-close: Private macros
Macro, tag-auto-close-stop: Private macros
Macro, tag-callback: Private macros
Macro, tag-name: Private macros
Macro, tag-no-end: Private macros
Macro, tag-no-pcdata: Private macros
make-collector: Private ordinary functions
make-tokenbuf: Private ordinary functions
Method, parse-html: Public generic functions
Method, parse-html: Public generic functions
Method, parse-html: Public generic functions

N
next-token: Private ordinary functions

P
parse-html: Public generic functions
parse-html: Public generic functions
parse-html: Public generic functions
parse-html: Public generic functions
phtml-internal: Public ordinary functions
put-back-collector: Private ordinary functions
put-back-tokenbuf: Private ordinary functions

T
tag-auto-close: Private macros
tag-auto-close-stop: Private macros
tag-callback: Private macros
tag-name: Private macros
tag-no-end: Private macros
tag-no-pcdata: Private macros
to-preferred-case: Private ordinary functions
tokenbuf-cur: Private ordinary functions
tokenbuf-data: Private ordinary functions
tokenbuf-first-pass: Private ordinary functions
tokenbuf-max: Private ordinary functions
tokenbuf-p: Private ordinary functions


A.3 Variables

Jump to:   *  
C   D   F   I   M   N   S  
Index Entry  Section

*
*ch-format*: Private special variables
*characteristics*: Private special variables
*collectors*: Private special variables
*html-entity-to-code*: Private special variables
*in-line*: Private special variables
*known-tags*: Private special variables
*kwd-package*: Private special variables
*tokenbufs*: Private special variables

C
char-attribnamechar: Private constants
char-attribundelimattribvalue: Private constants
char-spacechar: Private constants
char-tagcharacter: Private constants
Constant, char-attribnamechar: Private constants
Constant, char-attribundelimattribvalue: Private constants
Constant, char-spacechar: Private constants
Constant, char-tagcharacter: Private constants
Constant, state-attribname: Private constants
Constant, state-attribstartvalue: Private constants
Constant, state-attribvaluedelim: Private constants
Constant, state-attribvaluenodelim: Private constants
Constant, state-findattribname: Private constants
Constant, state-findvalue: Private constants
Constant, state-pcdata: Private constants
Constant, state-rawdata: Private constants
Constant, state-readcomment: Private constants
Constant, state-readcomment-one: Private constants
Constant, state-readcomment-two: Private constants
Constant, state-readtag: Private constants
Constant, state-readtagfirst: Private constants
cur: Private structures

D
data: Private structures
data: Private structures

F
first-pass: Private structures

I
if*-keyword-list: Private special variables

M
max: Private structures
max: Private structures

N
next: Private structures

S
Slot, cur: Private structures
Slot, data: Private structures
Slot, data: Private structures
Slot, first-pass: Private structures
Slot, max: Private structures
Slot, max: Private structures
Slot, next: Private structures
Special Variable, *ch-format*: Private special variables
Special Variable, *characteristics*: Private special variables
Special Variable, *collectors*: Private special variables
Special Variable, *html-entity-to-code*: Private special variables
Special Variable, *in-line*: Private special variables
Special Variable, *known-tags*: Private special variables
Special Variable, *kwd-package*: Private special variables
Special Variable, *tokenbufs*: Private special variables
Special Variable, if*-keyword-list: Private special variables
state-attribname: Private constants
state-attribstartvalue: Private constants
state-attribvaluedelim: Private constants
state-attribvaluenodelim: Private constants
state-findattribname: Private constants
state-findvalue: Private constants
state-pcdata: Private constants
state-rawdata: Private constants
state-readcomment: Private constants
state-readcomment-one: Private constants
state-readcomment-two: Private constants
state-readtag: Private constants
state-readtagfirst: Private constants


A.4 Data types