The rss Reference Manual

This is the rss Reference Manual, version 0.9.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:38:05 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 rss

Remote Site Summary

Maintainer

Kevin M. Rosenberg <>

Author

Kevin Rosenberg based on work by Craig Brozensky

License

BSD

Version

0.9.1.1

Dependencies
  • kmrcl (system).
  • xmls (system).
  • aserve (system).
Source

rss.asd.

Child Components

2 Files

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


2.1 Lisp


2.1.1 rss/rss.asd

Source

rss.asd.

Parent Component

rss (system).

ASDF Systems

rss.

Packages

rss-system.


2.1.2 rss/package.lisp

Source

rss.asd.

Parent Component

rss (system).

Packages

rss.


2.1.3 rss/main.lisp

Dependency

package.lisp (file).

Source

rss.asd.

Parent Component

rss (system).

Public Interface
Internals

3 Packages

Packages are listed by definition order.


3.1 rss

Source

package.lisp.

Use List
  • common-lisp.
  • kmrcl.
Public Interface
Internals

3.2 rss-system

Source

rss.asd.

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

4 Definitions

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


4.1 Public Interface


4.1.1 Ordinary functions

Function: parse-rss-file (file)
Package

rss.

Source

main.lisp.

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.

Function: rss-site (uri)
Package

rss.

Source

main.lisp.

Function: show-sites (&optional sites)
Package

rss.

Source

main.lisp.


4.1.2 Generic functions

Generic Reader: description (object)
Package

rss.

Methods
Reader Method: description ((rss-image rss-image))

automatically generated reader method

Source

main.lisp.

Target Slot

description.

Reader Method: description ((rss-item rss-item))

automatically generated reader method

Source

main.lisp.

Target Slot

description.

Reader Method: description ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

description.

Generic Reader: height (object)
Package

rss.

Methods
Reader Method: height ((rss-image rss-image))

automatically generated reader method

Source

main.lisp.

Target Slot

height.

Generic Reader: image (object)
Package

rss.

Methods
Reader Method: image ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

image.

Generic Reader: items (object)
Package

rss.

Methods
Reader Method: items ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

items.

Generic Writer: (setf items) (object)
Package

rss.

Methods
Writer Method: (setf items) ((rss-channel rss-channel))

automatically generated writer method

Source

main.lisp.

Target Slot

items.

Generic Reader: language (object)
Package

rss.

Methods
Reader Method: language ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

language.

Generic Reader: last-build-date (object)
Package

rss.

Methods
Reader Method: last-build-date ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

last-build-date.

Package

rss.

Methods

automatically generated reader method

Source

main.lisp.

Target Slot

link.

automatically generated reader method

Source

main.lisp.

Target Slot

link.

automatically generated reader method

Source

main.lisp.

Target Slot

link.

Generic Reader: pub-date (object)
Package

rss.

Methods
Reader Method: pub-date ((rss-item rss-item))

automatically generated reader method

Source

main.lisp.

Target Slot

pub-date.

Reader Method: pub-date ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

pub-date.

Generic Reader: title (object)
Package

rss.

Methods
Reader Method: title ((rss-image rss-image))

automatically generated reader method

Source

main.lisp.

Target Slot

title.

Reader Method: title ((rss-item rss-item))

automatically generated reader method

Source

main.lisp.

Target Slot

title.

Reader Method: title ((rss-channel rss-channel))

automatically generated reader method

Source

main.lisp.

Target Slot

title.

Generic Reader: url (object)
Package

rss.

Methods
Reader Method: url ((rss-image rss-image))

automatically generated reader method

Source

main.lisp.

Target Slot

url.

Generic Reader: width (object)
Package

rss.

Methods
Reader Method: width ((rss-image rss-image))

automatically generated reader method

Source

main.lisp.

Target Slot

width.


4.1.3 Classes

Class: rss-channel
Package

rss.

Source

main.lisp.

Direct methods
Direct slots
Slot: title
Readers

title.

Writers

This slot is read-only.

Readers

link.

Writers

This slot is read-only.

Slot: description
Readers

description.

Writers

This slot is read-only.

Slot: language
Readers

language.

Writers

This slot is read-only.

Slot: image
Readers

image.

Writers

This slot is read-only.

Slot: pub-date
Readers

pub-date.

Writers

This slot is read-only.

Slot: last-build-date
Readers

last-build-date.

Writers

This slot is read-only.

Slot: items
Readers

items.

Writers

(setf items).

Class: rss-image
Package

rss.

Source

main.lisp.

Direct methods
Direct slots
Slot: url
Readers

url.

Writers

This slot is read-only.

Slot: title
Readers

title.

Writers

This slot is read-only.

Readers

link.

Writers

This slot is read-only.

Slot: width
Readers

width.

Writers

This slot is read-only.

Slot: height
Readers

height.

Writers

This slot is read-only.

Slot: description
Readers

description.

Writers

This slot is read-only.

Class: rss-item
Package

rss.

Source

main.lisp.

Direct methods
Direct slots
Slot: title
Readers

title.

Writers

This slot is read-only.

Readers

link.

Writers

This slot is read-only.

Slot: description
Readers

description.

Writers

This slot is read-only.

Slot: pub-date
Readers

pub-date.

Writers

This slot is read-only.


4.2 Internals


4.2.1 Special variables

Special Variable: *sites*
Package

rss.

Source

main.lisp.


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.

Macro: string=-case (keyform (&rest cases) &optional &body otherwise)

A version of CASE that tests using string=.

Package

rss.

Source

main.lisp.


4.2.3 Ordinary functions

Function: display-site (site &key stream)
Package

rss.

Source

main.lisp.

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.

Function: is-rss-version-supported (version-string)
Package

rss.

Source

main.lisp.

Function: parse-channel-child (node object strict?)
Package

rss.

Source

main.lisp.

Function: parse-image (node strict?)
Package

rss.

Source

main.lisp.

Function: parse-image-child (node object strict?)
Package

rss.

Source

main.lisp.

Function: parse-item (node strict?)
Package

rss.

Source

main.lisp.

Function: parse-item-child (node object strict?)
Package

rss.

Source

main.lisp.

Function: parse-type (class child-parser node strict? required-string-slots)
Package

rss.

Source

main.lisp.

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.

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.

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.


4.2.4 Generic functions

Generic Reader: msg (condition)
Package

rss.

Methods
Reader Method: msg ((condition rss-parse-error))
Source

main.lisp.

Target Slot

msg.

Generic Reader: version (condition)
Package

rss.

Methods
Reader Method: version ((condition rss-version-unsupported))
Source

main.lisp.

Target Slot

version.


4.2.5 Conditions

Condition: rss-parse-error

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

Package

rss.

Source

main.lisp.

Direct superclasses

error.

Direct subclasses

rss-version-unsupported.

Direct methods

msg.

Direct slots
Slot: msg
Initargs

:msg

Readers

msg.

Writers

This slot is read-only.

Condition: rss-version-unsupported

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

Package

rss.

Source

main.lisp.

Direct superclasses

rss-parse-error.

Direct methods

version.

Direct slots
Slot: version
Initargs

:version

Readers

version.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


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): Public generic functions
(setf items): Public generic functions

D
def-child-parser: Private macros
description: Public generic functions
description: Public generic functions
description: Public generic functions
description: Public generic functions
display-site: Private ordinary functions

E
ensure-string-slots-filled: Private ordinary functions

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

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

H
height: Public generic functions
height: Public generic functions

I
image: Public generic functions
image: Public generic functions
is-rss-version-supported: Private ordinary functions
items: Public generic functions
items: Public generic functions

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

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

P
parse-channel-child: Private ordinary functions
parse-image: Private ordinary functions
parse-image-child: Private ordinary functions
parse-item: Private ordinary functions
parse-item-child: Private ordinary functions
parse-rss-file: Public ordinary functions
parse-rss-stream: Public ordinary functions
parse-type: Private ordinary functions
pub-date: Public generic functions
pub-date: Public generic functions
pub-date: Public generic functions

R
rss-site: Public ordinary functions

S
setf-unique-slot: Private ordinary functions
setf-unique-string: Private ordinary functions
show-sites: Public ordinary functions
string=-case: Private macros
symbol-to-name: Private ordinary functions

T
title: Public generic functions
title: Public generic functions
title: Public generic functions
title: Public generic functions

U
url: Public generic functions
url: Public generic functions

V
version: Private generic functions
version: Private generic functions

W
width: Public generic functions
width: Public generic functions