The cl-rss Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-rss Reference Manual

This is the cl-rss Reference Manual, version 0.9.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:16:24 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 rss

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Kevin Rosenberg based on work by Craig Brozensky

License

BSD

Description

Remote Site Summary

Version

0.9.0

Dependencies
Source

rss.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 rss.asd

Location

rss.asd

Systems

rss (system)

Packages

rss-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 rss/package.lisp

Parent

rss (system)

Location

package.lisp

Packages

rss


Previous: , Up: Lisp files   [Contents][Index]

2.1.3 rss/main.lisp

Dependency

package.lisp (file)

Parent

rss (system)

Location

main.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 rss-system

Source

rss.asd

Use List

Previous: , Up: Packages   [Contents][Index]

3.2 rss

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Functions

Function: parse-rss-file FILE
Package

rss

Source

main.lisp (file)

Function: parse-rss-stream STR &key ERR STRICT?

Parse RSS data from STR, which can be either a stream or a string. If ERR, then throw an error when something goes wrong, otherwise just return NIL. If STRICT?, check more carefully for whether the document fails to follow the RSS 2.0 specification (which incorporates 0.9x)

Package

rss

Source

main.lisp (file)

Function: rss-site URI
Package

rss

Source

main.lisp (file)

Function: show-sites &optional SITES
Package

rss

Source

main.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Generic functions

Generic Function: description OBJECT
Package

rss

Methods
Method: description (RSS-IMAGE rss-image)

automatically generated reader method

Source

main.lisp (file)

Method: description (RSS-ITEM rss-item)

automatically generated reader method

Source

main.lisp (file)

Method: description (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: height OBJECT
Package

rss

Methods
Method: height (RSS-IMAGE rss-image)

automatically generated reader method

Source

main.lisp (file)

Generic Function: image OBJECT
Package

rss

Methods
Method: image (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: items OBJECT
Generic Function: (setf items) NEW-VALUE OBJECT
Package

rss

Methods
Method: items (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Method: (setf items) NEW-VALUE (RSS-CHANNEL rss-channel)

automatically generated writer method

Source

main.lisp (file)

Generic Function: language OBJECT
Package

rss

Methods
Method: language (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: last-build-date OBJECT
Package

rss

Methods
Method: last-build-date (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: link OBJECT
Package

rss

Methods
Method: link (RSS-IMAGE rss-image)

automatically generated reader method

Source

main.lisp (file)

Method: link (RSS-ITEM rss-item)

automatically generated reader method

Source

main.lisp (file)

Method: link (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: pub-date OBJECT
Package

rss

Methods
Method: pub-date (RSS-ITEM rss-item)

automatically generated reader method

Source

main.lisp (file)

Method: pub-date (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: title OBJECT
Package

rss

Methods
Method: title (RSS-IMAGE rss-image)

automatically generated reader method

Source

main.lisp (file)

Method: title (RSS-ITEM rss-item)

automatically generated reader method

Source

main.lisp (file)

Method: title (RSS-CHANNEL rss-channel)

automatically generated reader method

Source

main.lisp (file)

Generic Function: url OBJECT
Package

rss

Methods
Method: url (RSS-IMAGE rss-image)

automatically generated reader method

Source

main.lisp (file)

Generic Function: width OBJECT
Package

rss

Methods
Method: width (RSS-IMAGE rss-image)

automatically generated reader method

Source

main.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Classes

Class: rss-channel ()
Package

rss

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: title
Readers

title (generic function)

Slot: link
Readers

link (generic function)

Slot: description
Readers

description (generic function)

Slot: language
Readers

language (generic function)

Slot: image
Readers

image (generic function)

Slot: pub-date
Readers

pub-date (generic function)

Slot: last-build-date
Readers

last-build-date (generic function)

Slot: items
Readers

items (generic function)

Writers

(setf items) (generic function)

Class: rss-image ()
Package

rss

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: url
Readers

url (generic function)

Slot: title
Readers

title (generic function)

Slot: link
Readers

link (generic function)

Slot: width
Readers

width (generic function)

Slot: height
Readers

height (generic function)

Slot: description
Readers

description (generic function)

Class: rss-item ()
Package

rss

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: title
Readers

title (generic function)

Slot: link
Readers

link (generic function)

Slot: description
Readers

description (generic function)

Slot: pub-date
Readers

pub-date (generic function)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

Special Variable: *sites*
Package

rss

Source

main.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Macros

Macro: def-child-parser NAME (&rest UNIQUE-STRINGS) &rest COMPLICATED-FORMS

Define a parser that sets UNIQUE-STRINGS in the obvious
way. COMPLICATED-FORMS should be lists (KEY &body BODY) where KEY is a string and BODY is performed with ITEM set to the item we’re modifying and NODE set to the XML node we just got.

Package

rss

Source

main.lisp (file)

Macro: string=-case KEYFORM (&rest CASES) &optional &body OTHERWISE

A version of CASE that tests using string=.

Package

rss

Source

main.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Functions

Function: display-site SITE &key STREAM
Package

rss

Source

main.lisp (file)

Function: ensure-string-slots-filled OBJECT REQUIRED-SLOTS STRICT?

For each slot in REQUIRED-SLOTS, if it is unbound in OBJECT, set it to the empty string if STRICT? is NIL, or throw an error if true.

Package

rss

Source

main.lisp (file)

Function: is-rss-version-supported VERSION-STRING
Package

rss

Source

main.lisp (file)

Function: parse-channel-child NODE OBJECT STRICT?
Package

rss

Source

main.lisp (file)

Function: parse-image NODE STRICT?
Package

rss

Source

main.lisp (file)

Function: parse-image-child NODE OBJECT STRICT?
Package

rss

Source

main.lisp (file)

Function: parse-item NODE STRICT?
Package

rss

Source

main.lisp (file)

Function: parse-item-child NODE OBJECT STRICT?
Package

rss

Source

main.lisp (file)

Function: parse-type CLASS CHILD-PARSER NODE STRICT? REQUIRED-STRING-SLOTS
Package

rss

Source

main.lisp (file)

Function: setf-unique-slot OBJECT NAME VALUE

Set the slot with the given NAME in OBJECT to VALUE, throwing an error if it was already set.

Package

rss

Source

main.lisp (file)

Function: setf-unique-string OBJECT NAME NODE

Set the slot with the given NAME in OBJECT to the string contents of NODE, throwing an error if it was already set, or if they aren’t a string. Used for elements like <title> and <link>, which shouldn’t crop up twice.

Package

rss

Source

main.lisp (file)

Function: symbol-to-name SYM

Convert symbols in the form SOME-SYM to RSS-style camelCase (a lopsided camel, it seems).

Package

rss

Source

main.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Generic functions

Generic Function: msg CONDITION
Package

rss

Methods
Method: msg (CONDITION rss-parse-error)
Source

main.lisp (file)

Generic Function: version CONDITION
Package

rss

Methods
Method: version (CONDITION rss-version-unsupported)
Source

main.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.5 Conditions

Condition: rss-parse-error ()

Thrown when PARSE-RSS-STREAM encounters invalid RSS data.

Package

rss

Source

main.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

rss-version-unsupported (condition)

Direct methods

msg (method)

Direct slots
Slot: msg
Initargs

:msg

Readers

msg (generic function)

Condition: rss-version-unsupported ()

Thrown when PARSE-RSS-STREAM encounters RSS of a version it doesn’t recognise.

Package

rss

Source

main.lisp (file)

Direct superclasses

rss-parse-error (condition)

Direct methods

version (method)

Direct slots
Slot: version
Initargs

:version

Readers

version (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

F
File, Lisp, rss.asd: The rss<dot>asd file
File, Lisp, rss/main.lisp: The rss/main<dot>lisp file
File, Lisp, rss/package.lisp: The rss/package<dot>lisp file

L
Lisp File, rss.asd: The rss<dot>asd file
Lisp File, rss/main.lisp: The rss/main<dot>lisp file
Lisp File, rss/package.lisp: The rss/package<dot>lisp file

R
rss.asd: The rss<dot>asd file
rss/main.lisp: The rss/main<dot>lisp file
rss/package.lisp: The rss/package<dot>lisp file

Jump to:   F   L   R  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

(
(setf items): Exported generic functions
(setf items): Exported generic functions

D
def-child-parser: Internal macros
description: Exported generic functions
description: Exported generic functions
description: Exported generic functions
description: Exported generic functions
display-site: Internal functions

E
ensure-string-slots-filled: Internal functions

F
Function, display-site: Internal functions
Function, ensure-string-slots-filled: Internal functions
Function, is-rss-version-supported: Internal functions
Function, parse-channel-child: Internal functions
Function, parse-image: Internal functions
Function, parse-image-child: Internal functions
Function, parse-item: Internal functions
Function, parse-item-child: Internal functions
Function, parse-rss-file: Exported functions
Function, parse-rss-stream: Exported functions
Function, parse-type: Internal functions
Function, rss-site: Exported functions
Function, setf-unique-slot: Internal functions
Function, setf-unique-string: Internal functions
Function, show-sites: Exported functions
Function, symbol-to-name: Internal functions

G
Generic Function, (setf items): Exported generic functions
Generic Function, description: Exported generic functions
Generic Function, height: Exported generic functions
Generic Function, image: Exported generic functions
Generic Function, items: Exported generic functions
Generic Function, language: Exported generic functions
Generic Function, last-build-date: Exported generic functions
Generic Function, link: Exported generic functions
Generic Function, msg: Internal generic functions
Generic Function, pub-date: Exported generic functions
Generic Function, title: Exported generic functions
Generic Function, url: Exported generic functions
Generic Function, version: Internal generic functions
Generic Function, width: Exported generic functions

H
height: Exported generic functions
height: Exported generic functions

I
image: Exported generic functions
image: Exported generic functions
is-rss-version-supported: Internal functions
items: Exported generic functions
items: Exported generic functions

L
language: Exported generic functions
language: Exported generic functions
last-build-date: Exported generic functions
last-build-date: Exported generic functions
link: Exported generic functions
link: Exported generic functions
link: Exported generic functions
link: Exported generic functions

M
Macro, def-child-parser: Internal macros
Macro, string=-case: Internal macros
Method, (setf items): Exported generic functions
Method, description: Exported generic functions
Method, description: Exported generic functions
Method, description: Exported generic functions
Method, height: Exported generic functions
Method, image: Exported generic functions
Method, items: Exported generic functions
Method, language: Exported generic functions
Method, last-build-date: Exported generic functions
Method, link: Exported generic functions
Method, link: Exported generic functions
Method, link: Exported generic functions
Method, msg: Internal generic functions
Method, pub-date: Exported generic functions
Method, pub-date: Exported generic functions
Method, title: Exported generic functions
Method, title: Exported generic functions
Method, title: Exported generic functions
Method, url: Exported generic functions
Method, version: Internal generic functions
Method, width: Exported generic functions
msg: Internal generic functions
msg: Internal generic functions

P
parse-channel-child: Internal functions
parse-image: Internal functions
parse-image-child: Internal functions
parse-item: Internal functions
parse-item-child: Internal functions
parse-rss-file: Exported functions
parse-rss-stream: Exported functions
parse-type: Internal functions
pub-date: Exported generic functions
pub-date: Exported generic functions
pub-date: Exported generic functions

R
rss-site: Exported functions

S
setf-unique-slot: Internal functions
setf-unique-string: Internal functions
show-sites: Exported functions
string=-case: Internal macros
symbol-to-name: Internal functions

T
title: Exported generic functions
title: Exported generic functions
title: Exported generic functions
title: Exported generic functions

U
url: Exported generic functions
url: Exported generic functions

V
version: Internal generic functions
version: Internal generic functions

W
width: Exported generic functions
width: Exported generic functions

Jump to:   (  
D   E   F   G   H   I   L   M   P   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
D   H   I   L   M   P   S   T   U   V   W  
Index Entry  Section

*
*sites*: Internal special variables

D
description: Exported classes
description: Exported classes
description: Exported classes

H
height: Exported classes

I
image: Exported classes
items: Exported classes

L
language: Exported classes
last-build-date: Exported classes
link: Exported classes
link: Exported classes
link: Exported classes

M
msg: Internal conditions

P
pub-date: Exported classes
pub-date: Exported classes

S
Slot, description: Exported classes
Slot, description: Exported classes
Slot, description: Exported classes
Slot, height: Exported classes
Slot, image: Exported classes
Slot, items: Exported classes
Slot, language: Exported classes
Slot, last-build-date: Exported classes
Slot, link: Exported classes
Slot, link: Exported classes
Slot, link: Exported classes
Slot, msg: Internal conditions
Slot, pub-date: Exported classes
Slot, pub-date: Exported classes
Slot, title: Exported classes
Slot, title: Exported classes
Slot, title: Exported classes
Slot, url: Exported classes
Slot, version: Internal conditions
Slot, width: Exported classes
Special Variable, *sites*: Internal special variables

T
title: Exported classes
title: Exported classes
title: Exported classes

U
url: Exported classes

V
version: Internal conditions

W
width: Exported classes

Jump to:   *  
D   H   I   L   M   P   S   T   U   V   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   R   S  
Index Entry  Section

C
Class, rss-channel: Exported classes
Class, rss-image: Exported classes
Class, rss-item: Exported classes
Condition, rss-parse-error: Internal conditions
Condition, rss-version-unsupported: Internal conditions

P
Package, rss: The rss package
Package, rss-system: The rss-system package

R
rss: The rss system
rss: The rss package
rss-channel: Exported classes
rss-image: Exported classes
rss-item: Exported classes
rss-parse-error: Internal conditions
rss-system: The rss-system package
rss-version-unsupported: Internal conditions

S
System, rss: The rss system

Jump to:   C   P   R   S