The postmodernity Reference Manual

Table of Contents

The postmodernity Reference Manual

This is the postmodernity Reference Manual, version 0.0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:43:05 2020 GMT+0.

1 Introduction

postmodernity

Postmodernity is a utility library for the Common Lisp Postmodern library.

Postmodernity provides the DEFPGSTRUCT macro to define a Common Lisp structure and corresponding Postmodern row reader. DEFPGSTRUCT is not intended to provide a structure-based alternative to Postmodern's data access objects but, rather, an alternative to list and alist row readers.

Based on the structure name, DEFPGSTRUCT also creates keyword symbols and adds them to POSTMODERN::*RESULT-STYLES* so that they can be used as result format arguments to POSTMODERN:QUERY, POSTMODERN:PREPARE, POSTMODERN:DEFPREPARED, and POSTMODERN:DEFPREPARED-WITH-NAMES. Note that, in doing so, DEFPGSTRUCT accesses unexported symbols from the POSTMODERN package.

Postmodernity depends on Postmodern and Alexandria. Postmodernity is being developed with SBCL, CCL, and LispWorks on OS X. Postmodernity is being deployed with SBCL on Linux/AMD64.

Installation

(ql:quickload "postmodernity")

Example

(postmodernity:defpgstruct site
  no
  name
  address
  (age #'(lambda (string)
           (ignore-errors (parse-integer string
                                         :junk-allowed t)))))

(postmodern:defprepared-with-names select-site (no)
  ((:select 'no 'name 'address 'age :from 'site :where (:= 'no '$1))
   no)
  :site)

(postmodern:defprepared-with-names select-site! (no)
  ((:select 'no 'name 'address 'age :from 'site :where (:= 'no '$1))
   no)
  :site!)

(postmodern:defprepared select-all-sites
  (:select 'no 'name 'address 'age :from 'site)
  :sites)

License

Postmodernity is distributed under the MIT license. See LICENSE.

2 Systems

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

2.1 postmodernity

Author

Michael J. Forster <mike@forsterfamily.ca>

License

MIT

Description

Utility library for the Common Lisp Postmodern library

Version

0.0.2

Dependencies

• alexandria
• postmodern

Source

postmodernity.asd (file)

Components

• package.lisp (file)
• postmodernity.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 postmodernity.asd

Location

postmodernity.asd

Systems

postmodernity (system)

3.1.2 postmodernity/package.lisp

Parent

postmodernity (system)

Location

package.lisp

Packages

postmodernity

3.1.3 postmodernity/postmodernity.lisp

Dependency

package.lisp (file)

Parent

postmodernity (system)

Location

postmodernity.lisp

Exported Definitions

defpgstruct (macro)

Internal Definitions

• add-result-style (function)
• make-all-rows-name (function)
• make-constructor-argument-form (function)
• make-constructor-argument-keyword (function)
• make-default-constructor-name (function)
• make-row-reader-name (function)
• make-single-row!-name (function)
• make-single-row-name (function)
• make-slot-description (function)
• slot-spec-name (function)
• slot-spec-reader (function)

4 Packages

Packages are listed by definition order.

4.1 postmodernity

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

defpgstruct (macro)

Internal Definitions

• add-result-style (function)
• make-all-rows-name (function)
• make-constructor-argument-form (function)
• make-constructor-argument-keyword (function)
• make-default-constructor-name (function)
• make-row-reader-name (function)
• make-single-row!-name (function)
• make-single-row-name (function)
• make-slot-description (function)
• slot-spec-name (function)
• slot-spec-reader (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: defpgstruct STRUCTURE-NAME &body SLOT-SPECS

Defines a structured type, named /structure-type/, with named slots as specified by /slot-specs/ and defines a Postmodern row reader named /structure-name/-ROW-READER.

DEFPGSTRUCT creates and adds to POSTMODERN::*RESULT-STYLES* the keywords named structure-name and by concatenating with S and !. Those keywords can be used as result format arguments to POSTMODERN:QUERY, POSTMODERN:PREPARE, POSTMODERN:DEFPREPARED, and POSTMODERN:DEFPREPARED-WITH-NAMES. Note that, in doing so, DEFPGSTRUCT accesses unexported symbols from the POSTMODERN package.

/structure-name/ must be a symbol, like a Common Lisp structure /structure-name/ rather than a Common Lisp structure /name-and-options/.

Each /slot-spec/ must be either a symbol specifying the slot name or a list of a symbol specifying the slot name and a desginator for a function to read and convert the PostgreSQL string value when initializing the slot value. If /slot-spec/ is a symbol, the slot value will be initialized to the PostgreSQL string value.

Package

postmodernity

Source

postmodernity.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: add-result-style STYLE-NAME ROW-READER-NAME RESULT-NAME

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-all-rows-name STRUCTURE-NAME

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-constructor-argument-form SLOT-SPEC FIELDS I

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-constructor-argument-keyword SLOT-SPEC

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-default-constructor-name STRUCTURE-NAME

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-row-reader-name STRUCTURE-NAME

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-single-row!-name STRUCTURE-NAME

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-single-row-name STRUCTURE-NAME

Package

postmodernity

Source

postmodernity.lisp (file)

Function: make-slot-description SLOT-SPEC

Package

postmodernity

Source

postmodernity.lisp (file)

Function: slot-spec-name SLOT-SPEC

Package

postmodernity

Source

postmodernity.lisp (file)

Function: slot-spec-reader SLOT-SPEC

Package

postmodernity

Source

postmodernity.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types