The phos Reference Manual

Table of Contents

The phos Reference Manual

This is the phos Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:48:23 2022 GMT+0.

1 Introduction

phos

Phos (short for phosphophyllite) is both a Gemini client library for Common Lisp and an experiment at making a GUI in lisp.

License

ISC

2 Systems

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

2.1 phos

Author

Omar Polo <op@omarpolo.com>

License

ISC

Description

An experimental Gemini client library

Version

0.0.1

Dependencies

• quri
• cl-ppcre
• trivia
• usocket
• cl+ssl

Source

phos.asd (file)

Components

• package.lisp (file)
• phos.lisp (file)
• gemtext.lisp (file)
• gemini.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 phos.asd

Location

phos.asd

Systems

phos (system)

3.1.2 phos/package.lisp

Parent

phos (system)

Location

package.lisp

Packages

• phos
• phos/gemini
• phos/gemtext

3.1.3 phos/phos.lisp

Dependency

package.lisp (file)

Parent

phos (system)

Location

phos.lisp

3.1.4 phos/gemtext.lisp

Dependency

phos.lisp (file)

Parent

phos (system)

Location

gemtext.lisp

Exported Definitions

• alt (method)
• (setf alt) (method)
• blockquote (class)
• blockquote-p (function)
• element (class)
• element-p (function)
• item (class)
• item-p (function)
• level (method)
• (setf level) (method)
• line-eq (generic function)
• line-eq (method)
• line-eq (method)
• line-eq (method)
• line-eq (method)
• link (class)
• link-p (function)
• paragraph (class)
• paragraph-p (function)
• parse (function)
• parse-string (function)
• text (method)
• (setf text) (method)
• title (class)
• title-p (function)
• unparse (generic function)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• url (method)
• (setf url) (method)
• verbatim (class)
• verbatim-p (function)

Internal Definitions

• make-link (function)
• markerp (macro)
• parse-line (function)
• parse-link (function)

3.1.5 phos/gemini.lisp

Dependency

gemtext.lisp (file)

Parent

phos (system)

Location

gemini.lisp

Exported Definitions

• *code-to-keyword* (special variable)
• *default-port* (special variable)
• request (generic function)
• request (method)
• with-gemini-request (macro)

Internal Definitions

• malformed-response (condition)
• parse-response (function)
• parse-status (function)
• read-all-bytes (function)
• read-all-string (function)
• read-until (function)
• reason (method)

4 Packages

Packages are listed by definition order.

4.1 phos

Source

package.lisp (file)

Use List

common-lisp

4.2 phos/gemini

Gemini (the protocol) implementation

Source

package.lisp (file)

Nickname

gemini

Use List

• trivia.level2
• common-lisp

Exported Definitions

• *code-to-keyword* (special variable)
• *default-port* (special variable)
• request (generic function)
• request (method)
• with-gemini-request (macro)

Internal Definitions

• malformed-response (condition)
• parse-response (function)
• parse-status (function)
• read-all-bytes (function)
• read-all-string (function)
• read-until (function)
• reason (generic function)
• reason (method)

4.3 phos/gemtext

Gemtext (text/gemini) parsing

Source

package.lisp (file)

Nickname

gemtext

Use List

• trivia.level2
• common-lisp

Exported Definitions

• alt (generic function)
• alt (method)
• (setf alt) (method)
• (setf alt) (generic function)
• blockquote (class)
• blockquote-p (function)
• element (class)
• element-p (function)
• item (class)
• item-p (function)
• level (generic function)
• level (method)
• (setf level) (method)
• (setf level) (generic function)
• line-eq (generic function)
• line-eq (method)
• line-eq (method)
• line-eq (method)
• line-eq (method)
• link (class)
• link-p (function)
• paragraph (class)
• paragraph-p (function)
• parse (function)
• parse-string (function)
• text (generic function)
• text (method)
• (setf text) (method)
• (setf text) (generic function)
• title (class)
• title-p (function)
• unparse (generic function)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• unparse (method)
• url (generic function)
• url (method)
• (setf url) (method)
• (setf url) (generic function)
• verbatim (class)
• verbatim-p (function)

Internal Definitions

• make-link (function)
• markerp (macro)
• parse-line (function)
• parse-link (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *code-to-keyword*

Maps status code to keyword name.

Package

phos/gemini

Source

gemini.lisp (file)

Special Variable: *default-port*

The default port for gemini URL.

Package

phos/gemini

Source

gemini.lisp (file)

5.1.2 Macros

Macro: with-gemini-request ((STATUS META STREAM) URL) &body BODY

Expose a stream (STREAM) with Gemini response contents, available in BODY.

STATUS and META are bound to the status code (as keyword from ‘*code-to-keyword*’) and meta info (as optional/nullable string.)

URL should be a well-formed string/‘quri:uri’ URL.

Package

phos/gemini

Source

gemini.lisp (file)

5.1.3 Functions

Function: blockquote-p BLOCKQUOTE

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: element-p ELEMENT

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: item-p ITEM

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: link-p LINK

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: paragraph-p PARAGRAPH

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: parse IN

Parse gemtext from the stream IN.

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: parse-string STR

Parse the string STR as gemtext.

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: title-p TITLE

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: verbatim-p VERBATIM

Package

phos/gemtext

Source

gemtext.lisp (file)

5.1.4 Generic functions

Generic Function: alt OBJECT

Generic Function: (setf alt) NEW-VALUE OBJECT

Package

phos/gemtext

Methods

Method: alt (VERBATIM verbatim)

Method: (setf alt) NEW-VALUE (VERBATIM verbatim)

The alternative text for the verbatim block.

Is usually put at the same line as the opening backquotes.

Can be a programming language name or alternative text for, e.g., ASCII art.

Source

gemtext.lisp (file)

Generic Function: level OBJECT

Generic Function: (setf level) NEW-VALUE OBJECT

Package

phos/gemtext

Methods

Method: level (TITLE title)

Method: (setf level) NEW-VALUE (TITLE title)

The nesting level of the title.

Synonymous to the HTML heading levels, i.e. level 1 is <h1> tag, level 2 is <h2> tag etc.

Source

gemtext.lisp (file)

Generic Function: line-eq A B

t if the lines A and B are equals.

Package

phos/gemtext

Source

gemtext.lisp (file)

Method Combination

and (short method combination)

Options: :most-specific-first

Methods

Method: line-eq (A verbatim) (B verbatim) and

Method: line-eq (A link) (B link) and

Method: line-eq (A title) (B title) and

Method: line-eq (A element) (B element) and

Generic Function: request URL

Perform a request for the URL.

Package

phos/gemini

Source

gemini.lisp (file)

Methods

Method: request URL

Generic Function: text OBJECT

Generic Function: (setf text) NEW-VALUE OBJECT

Package

phos/gemtext

Methods

Method: text (ELEMENT element)

automatically generated reader method

Source

gemtext.lisp (file)

Method: (setf text) NEW-VALUE (ELEMENT element)

automatically generated writer method

Source

gemtext.lisp (file)

Generic Function: unparse OBJ STREAM

Print a textual representation of OBJ onto STREAM.

Package

phos/gemtext

Source

gemtext.lisp (file)

Methods

Method: unparse (B blockquote) STREAM

Method: unparse (V verbatim) STREAM

Method: unparse (P paragraph) STREAM

Method: unparse (ITEM item) STREAM

Method: unparse (LINK link) STREAM

Method: unparse (TITLE title) STREAM

Method: unparse (L list) STREAM

Generic Function: url OBJECT

Generic Function: (setf url) NEW-VALUE OBJECT

Package

phos/gemtext

Methods

Method: url (LINK link)

automatically generated reader method

Source

gemtext.lisp (file)

Method: (setf url) NEW-VALUE (LINK link)

automatically generated writer method

Source

gemtext.lisp (file)

5.1.5 Classes

Class: blockquote ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

element (class)

Direct methods

unparse (method)

Class: element ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• title (class)
• link (class)
• item (class)
• paragraph (class)
• blockquote (class)
• verbatim (class)

Direct methods

• line-eq (method)
• text (method)
• text (method)

Direct slots

Slot: text

Type

string

Initargs

:text

Initform

""

Readers

text (generic function)

Writers

(setf text) (generic function)

Class: item ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

element (class)

Direct methods

unparse (method)

Class: link ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

element (class)

Direct methods

• line-eq (method)
• unparse (method)
• url (method)
• url (method)

Direct slots

Slot: url

Type

quri.uri:uri

Initargs

:url

Readers

url (generic function)

Writers

(setf url) (generic function)

Class: paragraph ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

element (class)

Direct methods

unparse (method)

Class: title ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

element (class)

Direct methods

• line-eq (method)
• unparse (method)
• level (method)
• level (method)

Direct slots

Slot: level

The nesting level of the title.

Synonymous to the HTML heading levels, i.e. level 1 is <h1> tag, level 2 is <h2> tag etc.

Type

integer

Initargs

:level

Readers

level (generic function)

Writers

(setf level) (generic function)

Class: verbatim ()

Package

phos/gemtext

Source

gemtext.lisp (file)

Direct superclasses

element (class)

Direct methods

• line-eq (method)
• unparse (method)
• alt (method)
• alt (method)

Direct slots

Slot: alt

The alternative text for the verbatim block.

Is usually put at the same line as the opening backquotes.

Can be a programming language name or alternative text for, e.g., ASCII art.

Type

(or null string)

Initargs

:alt

Readers

alt (generic function)

Writers

(setf alt) (generic function)

5.2 Internal definitions

5.2.1 Macros

Macro: markerp LINE

Package

phos/gemtext

Source

gemtext.lisp (file)

5.2.2 Functions

Function: make-link URL &optional TEXT

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: parse-line S

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: parse-link S

Parse a line into link.

Package

phos/gemtext

Source

gemtext.lisp (file)

Function: parse-response RES

Package

phos/gemini

Source

gemini.lisp (file)

Function: parse-status S

Package

phos/gemini

Source

gemini.lisp (file)

Function: read-all-bytes IN

Package

phos/gemini

Source

gemini.lisp (file)

Function: read-all-string IN

Package

phos/gemini

Source

gemini.lisp (file)

Function: read-until IN CHAR

Package

phos/gemini

Source

gemini.lisp (file)

5.2.3 Generic functions

Generic Function: reason CONDITION

Package

phos/gemini

Methods

Method: reason (CONDITION malformed-response)

Source

gemini.lisp (file)

5.2.4 Conditions

Condition: malformed-response ()

Package

phos/gemini

Source

gemini.lisp (file)

Direct superclasses

error (condition)

Direct methods

reason (method)

Direct slots

Slot: reason

Initargs

:reason

Readers

reason (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types