The clipper Reference Manual

This is the clipper Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:00:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clipper

File attachment library.

Author

Rudolph-Miller

License

MIT

Long Description

# Clipper
[![Build Status](https://circleci.com/gh/Rudolph-Miller/clipper.svg?style=shield)](https://circleci.com/gh/Rudolph-Miller/clipper)
[![Quicklisp dist](http://quickdocs.org/badge/clipper.svg)](http://quickdocs.org/clipper/)

Clipper is a file attachment library.

[Introduction to Clipper(Japanese)](http://blog.rudolph-miller.com/2015/08/10/introduction-to-clipper/)

## Usage

“‘Lisp
(in-package :cl-user)
(defpackage clipper.sample
(:use :cl
:integral
:clipper))
(in-package :clipper.sample)

(connect-toplevel :mysql :database-name "clipper_sample" :username "root")

(defclass picture ()
((id :col-type (:integer 11)
:primary-key t
:auto-increment t
:not-null t
:initarg :id)
(image-file-name :col-type (:varchar 255)
:initarg :image-file-name)
(image-content-type :col-type (:varchar 255)
:initarg :image-content-type)
(image-file-size :col-type (:integer 11)
:initarg :image-file-size)
(url :type string
:initarg :url))
(:metaclass <dao-table-class>)
(:table-name "pictures"))

(setup-clipper :store-type :s3
:aws-access-key (asdf::getenv "AWS_ACCESS_KEY")
:aws-secret-key (asdf::getenv "AWS_SECRET_KEY")
:s3-endpoint "s3-ap-northeast-1.amazonaws.com"
:s3-bucket-name "clipper-sample"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "https://s3-ap-northeast-1.amazonaws.com/clipper-sample/1/lisplogo_alien_256.png"

(setup-clipper :store-type :local
:image-directory #P"/home/cl-user/common-lisp/clipper/images/"
:relative #P"/home/cl-user/common-lisp/clipper/"
:prefix "http://localhost:3000/"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "http://localhsot:3000/images/2/lisplogo_alien_256.png"
“‘

## setup-clipper

“‘Lisp
(setup-clipper :store-type :local)
“‘

or

“‘Lisp
(setup-clipper :store-type :s3)
“‘

or you can create ‘:store-type‘ other than ‘:local‘ or ‘:s3‘.

### :store-type :local

“‘Lisp
(setup-clipper :store-type :local
:image-directory #P"/home/cl-user/common-lisp/clipper/images/"
:relative #P"/home/cl-user/common-lisp/clipper/"
:prefix "http://localhost:3000/"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "http://localhsot:3000/images/2/lisplogo_alien_256.png"
“‘

- ‘:image-directory‘

“‘Lisp
(setup-clipper :store-type :local
:image-directory #P"/home/cl-user/common-lisp/clipper/images/"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "/home/cl-user/common-lisp/clipper/images/2/lisplogo_alien_256.png"
“‘

- ‘:relative‘

“‘Lisp
(setup-clipper :store-type :local
:image-directory #P"/home/cl-user/common-lisp/clipper/images/"
:relative #P"/home/cl-user/common-lisp/clipper/"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "images/2/lisplogo_alien_256.png"
“‘

- ‘:prefix‘

“‘Lisp
(setup-clipper :store-type :local
:image-directory #P"/home/cl-user/common-lisp/clipper/images/"
:relative #P"/home/cl-user/common-lisp/clipper/"
:prefix "http://localhost:3000/"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "http://localhost3000/images/2/lisplogo_alien_256.png"
“‘

### :store-type :s3

“‘Lisp
(setup-clipper :store-type :s3
:aws-access-key (asdf::getenv "AWS_ACCESS_KEY")
:aws-secret-key (asdf::getenv "AWS_SECRET_KEY")
:s3-endpoint "s3-ap-northeast-1.amazonaws.com"
:s3-bucket-name "clipper-sample"
:clipper-class (find-class ’picture)
:format "images:ID/:FILE-NAME.:EXTENSION")

(let ((object (create-dao ’picture)))
(save-dao (attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png"))
(image-url object))

=> "https://s3-ap-northeast-1.amazonaws.com/clipper-sample/images/1/lisplogo_alien_256.png"
“‘

### :clipper-class

‘:clipper-class‘ can take any class or struct which have slots for ‘id‘, ‘image-file-name‘, ‘image-content-type‘, ‘image-file-size‘ and ‘url‘, and each slot can be specified by ‘setup-clipper‘.

“‘Lisp
(defclass picture ()
((id :col-type (:integer 11)
:primary-key t
:auto-increment t
:not-null t
:initarg :id)
(image-file-name :col-type (:varchar 255)
:initarg :image-file-name)
(image-content-type :col-type (:varchar 255)
:initarg :image-content-type)
(image-file-size :col-type (:integer 11)
:initarg :image-file-size)
(url :type string
:initarg :url))
(:metaclass <dao-table-class>)
(:table-name "pictures"))

(setup-clipper :clipper-class (find-class ’picture)
:id-slot ’id
:url-slot ’url
:image-file-name-slot ’image-file-name
:image-content-type-slot ’image-content-type
:image-file-size-slot ’image-file-size)
“‘

### :format

- ‘:format‘ can take string with ‘:KEYWORD‘ and ‘:KEYWORD‘ is declared in ‘*format-keys*‘.
- Default declared ‘:KEYWORD‘ is ‘:ID‘, ‘:URL‘, ‘:FILE-NAME‘ and ‘:EXTENSION‘.
- ‘*format-keys*‘ is a plist of ‘:KEYWORD‘ and ‘function‘ which will be called with ‘object‘.
- ‘:FILE-NAME‘ will return ‘:image-file-name‘ without extension.

“‘Lisp
(defvar *format-keys*
(list :ID #’clip-id
:URL #’clip-url
:FILE-NAME #’clip-image-file-name-without-extension
:EXTENSION #’clip-extension))

(store-format (setup-clipper :format ":ID/:URL/:FILE-NAME.:EXTENSION"))

(make-instance ’picture :id 1 :url "sample-url" :image-file-name "smaple.png")

=> format will be "1/sample-url/sample.png"
“‘

## attach-image
- ‘attach-image‘ take ‘object‘ and keyword arguments(‘:url‘, ‘:image‘, ‘:path-name‘ and ‘:file-name‘).
- ‘attach-image‘ return ‘object‘ with ‘image-file-name‘, ‘image-content-type‘, ‘image-file-size‘ and ‘url‘.
- You have to save returned ‘object‘ on yourself.

“‘Lisp
(let ((object (make-instance ’picture)))
(attach-image object :url "http://www.lisperati.com/lisplogo_alien_256.png")
(attach-image object :path-name "/home/lisp-user/image/lisplogo_alien_256.png")
(attach-image object :image (drakma:http-request "http://www.lisperati.com/lisplogo_alien_256.png")
:file-name "lisplogo_alien_256.nng")

;; or
(setf (picture-url object) "http://www.lisperati.com/lisplogo_alien_256.png")
(attach-image object))
“‘

## attach-image with resize

If you add ‘:width‘ and ‘:height‘, ‘attach-image‘ resize image with ‘opticl:fit-image-into‘.

“‘Lisp
(setup-clipper :store-type :local
:image-directory #P"/home/cl-user/common-lisp/clipper/images/"
:relative #P"/home/cl-user/common-lisp/clipper/"
:prefix "http://localhost:3000/"
:clipper-class (find-class ’picture)
:format ":ID/:FILE-NAME.:EXTENSION"
:width 200
:height 200)
“‘

## See Also

- [Integral](https://github.com/fukamachi/integral) - Object relational mapper for Common Lisp
- [opticl](https://github.com/slyrus/opticl) - A library for representing and processing images in Common Lisp

## Author

* Rudolph-Miller (chopsticks.tk.ppfm@gmail.com)

## Copyright

Copyright (c) 2015 Rudolph-Miller (chopsticks.tk.ppfm@gmail.com)

Version

0.1

Dependencies
  • cl-syntax-annot (system).
  • closer-mop (system).
  • dexador (system).
  • quri (system).
  • split-sequence (system).
  • alexandria (system).
  • zs3 (system).
  • cl-fad (system).
  • opticl (system).
  • fast-io (system).
Source

clipper.asd.

Child Component

src (module).


3 Modules

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


3.1 clipper/src

Source

clipper.asd.

Parent Component

clipper (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 clipper/clipper.asd

Source

clipper.asd.

Parent Component

clipper (system).

ASDF Systems

clipper.

Packages

clipper-asd.


4.1.2 clipper/src/clipper.lisp

Dependencies
Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.

Public Interface

image-url (function).


4.1.3 clipper/src/database.lisp

Dependencies
Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.database.

Public Interface

4.1.4 clipper/src/image.lisp

Dependency

database.lisp (file).

Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.image.

Public Interface
Internals

4.1.5 clipper/src/s3.lisp

Dependencies
Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.s3.

Public Interface
Internals

environment-credentials (class).


4.1.6 clipper/src/local.lisp

Dependencies
Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.local.

Public Interface

4.1.7 clipper/src/config.lisp

Dependency

error.lisp (file).

Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.config.

Public Interface
Internals

4.1.8 clipper/src/format.lisp

Dependency

database.lisp (file).

Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.format.

Public Interface

4.1.9 clipper/src/error.lisp

Source

clipper.asd.

Parent Component

src (module).

Packages

clipper.error.

Public Interface

5 Packages

Packages are listed by definition order.


5.1 clipper

Source

clipper.lisp.

Use List
  • cl-annot.doc.
  • common-lisp.
Public Interface

image-url (function).


5.2 clipper.database

Source

database.lisp.

Use List
Used By List
Public Interface

5.3 clipper.error

Source

error.lisp.

Use List

common-lisp.

Used By List
Public Interface

5.4 clipper.image

Source

image.lisp.

Use List
Used By List
Public Interface
Internals

5.5 clipper.config

Source

config.lisp.

Use List
Used By List
Public Interface
Internals

5.6 clipper.s3

Source

s3.lisp.

Use List
Public Interface

upload (function).

Internals

environment-credentials (class).


5.7 clipper.local

Source

local.lisp.

Use List
Public Interface

image-pathname (function).


5.8 clipper.format

Source

format.lisp.

Use List
Used By List
Public Interface

5.9 clipper-asd

Source

clipper.asd.

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

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *clipper-config*

Global variable for config object.

Package

clipper.config.

Source

config.lisp.

Special Variable: *format-keys*

List of functions used for #’store-format.

Package

clipper.format.

Source

format.lisp.

Special Variable: *supported-content-types*
Package

clipper.image.

Source

image.lisp.


6.1.2 Ordinary functions

Function: clip-extension (clip)
Package

clipper.database.

Source

database.lisp.

Function: clip-id (clip)
Package

clipper.database.

Source

database.lisp.

Function: clip-image-content-type (clip)
Package

clipper.database.

Source

database.lisp.

Function: (setf clip-image-content-type) (clip)
Package

clipper.database.

Source

database.lisp.

Function: clip-image-file-name (clip)
Package

clipper.database.

Source

database.lisp.

Function: (setf clip-image-file-name) (clip)
Package

clipper.database.

Source

database.lisp.

Function: clip-image-file-name-without-extension (clip)
Package

clipper.database.

Source

database.lisp.

Function: clip-image-file-size (clip)
Package

clipper.database.

Source

database.lisp.

Function: (setf clip-image-file-size) (clip)
Package

clipper.database.

Source

database.lisp.

Function: clip-url (clip)
Package

clipper.database.

Source

database.lisp.

Function: (setf clip-url) (clip)
Package

clipper.database.

Source

database.lisp.

Reader: clipper-config-aws-access-key (instance)
Writer: (setf clipper-config-aws-access-key) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

aws-access-key.

Reader: clipper-config-aws-secret-key (instance)
Writer: (setf clipper-config-aws-secret-key) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

aws-secret-key.

Reader: clipper-config-clipper-class (instance)
Writer: (setf clipper-config-clipper-class) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

clipper-class.

Reader: clipper-config-format (instance)
Writer: (setf clipper-config-format) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

format.

Reader: clipper-config-height (instance)
Writer: (setf clipper-config-height) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

height.

Reader: clipper-config-id-slot (instance)
Writer: (setf clipper-config-id-slot) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

id-slot.

Reader: clipper-config-image-content-type-slot (instance)
Writer: (setf clipper-config-image-content-type-slot) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

image-content-type-slot.

Reader: clipper-config-image-directory (instance)
Writer: (setf clipper-config-image-directory) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

image-directory.

Reader: clipper-config-image-file-name-slot (instance)
Writer: (setf clipper-config-image-file-name-slot) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

image-file-name-slot.

Reader: clipper-config-image-file-size-slot (instance)
Writer: (setf clipper-config-image-file-size-slot) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

image-file-size-slot.

Reader: clipper-config-prefix (instance)
Writer: (setf clipper-config-prefix) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

prefix.

Reader: clipper-config-relative (instance)
Writer: (setf clipper-config-relative) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

relative.

Reader: clipper-config-s3-bucket-name (instance)
Writer: (setf clipper-config-s3-bucket-name) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

s3-bucket-name.

Reader: clipper-config-s3-endpoint (instance)
Writer: (setf clipper-config-s3-endpoint) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

s3-endpoint.

Reader: clipper-config-store-type (instance)
Writer: (setf clipper-config-store-type) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

store-type.

Reader: clipper-config-url-slot (instance)
Writer: (setf clipper-config-url-slot) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

url-slot.

Reader: clipper-config-width (instance)
Writer: (setf clipper-config-width) (instance)
Package

clipper.config.

Source

config.lisp.

Target Slot

width.

Function: convert-image (image-vec type)
Package

clipper.image.

Source

image.lisp.

Function: get-extension (file-name)
Package

clipper.database.

Source

database.lisp.

Function: image-pathname (object)
Package

clipper.local.

Source

local.lisp.

Function: image-url (object)

Return URL for object.

Package

clipper.

Source

clipper.lisp.

Function: read-image-to-vector (input)
Package

clipper.image.

Source

image.lisp.

Function: setup-clipper (&rest initargs &key store-type image-directory relative prefix aws-access-key aws-secret-key s3-endpoint s3-bucket-name clipper-class id-slot url-slot image-file-name-slot image-content-type-slot image-file-size-slot format width height)

Setup clipper. You must call this before use clipper.

Package

clipper.config.

Source

config.lisp.

Function: store-format (object)

Return formatted id of object.

Package

clipper.format.

Source

format.lisp.

Function: upload (object key)
Package

clipper.s3.

Source

s3.lisp.

Function: write-image-to-out (image out)
Package

clipper.image.

Source

image.lisp.


6.1.3 Generic functions

Generic Function: attach-image (object &key url image path-name file-name)

Attach the image to the object.

Package

clipper.image.

Source

image.lisp.

Methods
Method: attach-image :around (object &key url image path-name file-name)
Method: attach-image (object &key url image path-name file-name)
Generic Function: retrieve-url (object type)
Package

clipper.format.

Source

format.lisp.

Methods
Method: retrieve-url (object (type (eql :local)))
Source

local.lisp.

Method: retrieve-url (object (type (eql :s3)))
Source

s3.lisp.

Generic Function: store-image (object image type)
Package

clipper.image.

Source

image.lisp.

Methods
Method: store-image (object image (type (eql :local)))
Source

local.lisp.

Method: store-image (object image (type (eql :s3)))
Source

s3.lisp.

Method: store-image :around (object image type)
Method: store-image (object image type)

6.1.4 Standalone methods

Method: access-key ((credentials environment-credentials))
Package

zs3.

Source

s3.lisp.

Method: secret-key ((credentials environment-credentials))
Package

zs3.

Source

s3.lisp.


6.1.5 Conditions

Condition: <clipper-error>

Base error condition.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

simple-error.

Direct subclasses
Condition: <clipper-image-type-error>

Image type error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-error>.

Direct slots
Slot: type

Type slot.

Package

common-lisp.

Initargs

:type

Condition: <clipper-incomplete-config>

Incomplete config error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-error>.

Direct subclasses
Direct slots
Slot: slot-list

Invalid slot list slot.

Initargs

:slot-list

Condition: <clipper-incomplete-for-attach-image>

Incomplete for attach-image.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-error>.

Direct slots
Slot: type

Type slot.

Package

common-lisp.

Initargs

:type

Slot: args

Args slot.

Initargs

:args

Condition: <clipper-incomplete-local-config>

Incomplete local config error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-incomplete-config>.

Condition: <clipper-incomplete-s3-config>

Incomplete S3 config error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-incomplete-config>.

Condition: <clipper-invalid-store-type>

Invalid stare type error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-error>.

Direct slots
Slot: type

Type slot.

Package

common-lisp.

Initargs

:type

Condition: <clipper-no-source-specified>

No source specified error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-error>.

Direct slots
Slot: object

Object slot.

Initargs

:object

Condition: <clipper-unsupported-content-type>

Unsupported content type error.

Package

clipper.error.

Source

error.lisp.

Direct superclasses

<clipper-error>.

Direct slots
Slot: content-type

Content type slot.

Initargs

:content-type


6.1.6 Structures

Structure: clipper-config
Package

clipper.config.

Source

config.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: store-type
Readers

clipper-config-store-type.

Writers

(setf clipper-config-store-type).

Slot: image-directory
Readers

clipper-config-image-directory.

Writers

(setf clipper-config-image-directory).

Slot: relative
Initform

""

Readers

clipper-config-relative.

Writers

(setf clipper-config-relative).

Slot: prefix
Initform

""

Readers

clipper-config-prefix.

Writers

(setf clipper-config-prefix).

Slot: aws-access-key
Readers

clipper-config-aws-access-key.

Writers

(setf clipper-config-aws-access-key).

Slot: aws-secret-key
Readers

clipper-config-aws-secret-key.

Writers

(setf clipper-config-aws-secret-key).

Slot: s3-bucket-name
Readers

clipper-config-s3-bucket-name.

Writers

(setf clipper-config-s3-bucket-name).

Slot: s3-endpoint
Readers

clipper-config-s3-endpoint.

Writers

(setf clipper-config-s3-endpoint).

Slot: clipper-class
Readers

clipper-config-clipper-class.

Writers

(setf clipper-config-clipper-class).

Slot: id-slot
Readers

clipper-config-id-slot.

Writers

(setf clipper-config-id-slot).

Slot: url-slot
Readers

clipper-config-url-slot.

Writers

(setf clipper-config-url-slot).

Slot: image-file-name-slot
Readers

clipper-config-image-file-name-slot.

Writers

(setf clipper-config-image-file-name-slot).

Slot: image-content-type-slot
Readers

clipper-config-image-content-type-slot.

Writers

(setf clipper-config-image-content-type-slot).

Slot: image-file-size-slot
Readers

clipper-config-image-file-size-slot.

Writers

(setf clipper-config-image-file-size-slot).

Slot: format
Package

common-lisp.

Initform

"/:id/:file-name.:extension"

Readers

clipper-config-format.

Writers

(setf clipper-config-format).

Slot: width
Readers

clipper-config-width.

Writers

(setf clipper-config-width).

Slot: height
Readers

clipper-config-height.

Writers

(setf clipper-config-height).


6.2 Internals


6.2.1 Special variables

Special Variable: *local-requrie-list*
Package

clipper.config.

Source

config.lisp.

Special Variable: *s3-require-list*
Package

clipper.config.

Source

config.lisp.


6.2.2 Ordinary functions

Function: %attach-image (object image file-name content-type)
Package

clipper.image.

Source

image.lisp.

Function: clipper-config-p (object)
Package

clipper.config.

Source

config.lisp.

Function: complete-slot-of-class (initargs)
Package

clipper.config.

Source

config.lisp.

Function: copy-clipper-config (instance)
Package

clipper.config.

Source

config.lisp.

Function: extension->type (extension)
Package

clipper.image.

Source

image.lisp.

Function: find-slot-by-the-name (class name)
Package

clipper.config.

Source

config.lisp.

Function: make-clipper-config (&key store-type image-directory relative prefix aws-access-key aws-secret-key s3-bucket-name s3-endpoint clipper-class id-slot url-slot image-file-name-slot image-content-type-slot image-file-size-slot format width height)
Package

clipper.config.

Source

config.lisp.

Function: temporary-file-template (type)
Package

clipper.image.

Source

image.lisp.


6.2.3 Classes

Class: environment-credentials
Package

clipper.s3.

Source

s3.lisp.

Direct methods

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   E   F   G   I   M   R   S   T   U   W  
Index Entry  Section

%
%attach-image: Private ordinary functions

(
(setf clip-image-content-type): Public ordinary functions
(setf clip-image-file-name): Public ordinary functions
(setf clip-image-file-size): Public ordinary functions
(setf clip-url): Public ordinary functions
(setf clipper-config-aws-access-key): Public ordinary functions
(setf clipper-config-aws-secret-key): Public ordinary functions
(setf clipper-config-clipper-class): Public ordinary functions
(setf clipper-config-format): Public ordinary functions
(setf clipper-config-height): Public ordinary functions
(setf clipper-config-id-slot): Public ordinary functions
(setf clipper-config-image-content-type-slot): Public ordinary functions
(setf clipper-config-image-directory): Public ordinary functions
(setf clipper-config-image-file-name-slot): Public ordinary functions
(setf clipper-config-image-file-size-slot): Public ordinary functions
(setf clipper-config-prefix): Public ordinary functions
(setf clipper-config-relative): Public ordinary functions
(setf clipper-config-s3-bucket-name): Public ordinary functions
(setf clipper-config-s3-endpoint): Public ordinary functions
(setf clipper-config-store-type): Public ordinary functions
(setf clipper-config-url-slot): Public ordinary functions
(setf clipper-config-width): Public ordinary functions

A
access-key: Public standalone methods
attach-image: Public generic functions
attach-image: Public generic functions
attach-image: Public generic functions

C
clip-extension: Public ordinary functions
clip-id: Public ordinary functions
clip-image-content-type: Public ordinary functions
clip-image-file-name: Public ordinary functions
clip-image-file-name-without-extension: Public ordinary functions
clip-image-file-size: Public ordinary functions
clip-url: Public ordinary functions
clipper-config-aws-access-key: Public ordinary functions
clipper-config-aws-secret-key: Public ordinary functions
clipper-config-clipper-class: Public ordinary functions
clipper-config-format: Public ordinary functions
clipper-config-height: Public ordinary functions
clipper-config-id-slot: Public ordinary functions
clipper-config-image-content-type-slot: Public ordinary functions
clipper-config-image-directory: Public ordinary functions
clipper-config-image-file-name-slot: Public ordinary functions
clipper-config-image-file-size-slot: Public ordinary functions
clipper-config-p: Private ordinary functions
clipper-config-prefix: Public ordinary functions
clipper-config-relative: Public ordinary functions
clipper-config-s3-bucket-name: Public ordinary functions
clipper-config-s3-endpoint: Public ordinary functions
clipper-config-store-type: Public ordinary functions
clipper-config-url-slot: Public ordinary functions
clipper-config-width: Public ordinary functions
complete-slot-of-class: Private ordinary functions
convert-image: Public ordinary functions
copy-clipper-config: Private ordinary functions

E
extension->type: Private ordinary functions

F
find-slot-by-the-name: Private ordinary functions
Function, %attach-image: Private ordinary functions
Function, (setf clip-image-content-type): Public ordinary functions
Function, (setf clip-image-file-name): Public ordinary functions
Function, (setf clip-image-file-size): Public ordinary functions
Function, (setf clip-url): Public ordinary functions
Function, (setf clipper-config-aws-access-key): Public ordinary functions
Function, (setf clipper-config-aws-secret-key): Public ordinary functions
Function, (setf clipper-config-clipper-class): Public ordinary functions
Function, (setf clipper-config-format): Public ordinary functions
Function, (setf clipper-config-height): Public ordinary functions
Function, (setf clipper-config-id-slot): Public ordinary functions
Function, (setf clipper-config-image-content-type-slot): Public ordinary functions
Function, (setf clipper-config-image-directory): Public ordinary functions
Function, (setf clipper-config-image-file-name-slot): Public ordinary functions
Function, (setf clipper-config-image-file-size-slot): Public ordinary functions
Function, (setf clipper-config-prefix): Public ordinary functions
Function, (setf clipper-config-relative): Public ordinary functions
Function, (setf clipper-config-s3-bucket-name): Public ordinary functions
Function, (setf clipper-config-s3-endpoint): Public ordinary functions
Function, (setf clipper-config-store-type): Public ordinary functions
Function, (setf clipper-config-url-slot): Public ordinary functions
Function, (setf clipper-config-width): Public ordinary functions
Function, clip-extension: Public ordinary functions
Function, clip-id: Public ordinary functions
Function, clip-image-content-type: Public ordinary functions
Function, clip-image-file-name: Public ordinary functions
Function, clip-image-file-name-without-extension: Public ordinary functions
Function, clip-image-file-size: Public ordinary functions
Function, clip-url: Public ordinary functions
Function, clipper-config-aws-access-key: Public ordinary functions
Function, clipper-config-aws-secret-key: Public ordinary functions
Function, clipper-config-clipper-class: Public ordinary functions
Function, clipper-config-format: Public ordinary functions
Function, clipper-config-height: Public ordinary functions
Function, clipper-config-id-slot: Public ordinary functions
Function, clipper-config-image-content-type-slot: Public ordinary functions
Function, clipper-config-image-directory: Public ordinary functions
Function, clipper-config-image-file-name-slot: Public ordinary functions
Function, clipper-config-image-file-size-slot: Public ordinary functions
Function, clipper-config-p: Private ordinary functions
Function, clipper-config-prefix: Public ordinary functions
Function, clipper-config-relative: Public ordinary functions
Function, clipper-config-s3-bucket-name: Public ordinary functions
Function, clipper-config-s3-endpoint: Public ordinary functions
Function, clipper-config-store-type: Public ordinary functions
Function, clipper-config-url-slot: Public ordinary functions
Function, clipper-config-width: Public ordinary functions
Function, complete-slot-of-class: Private ordinary functions
Function, convert-image: Public ordinary functions
Function, copy-clipper-config: Private ordinary functions
Function, extension->type: Private ordinary functions
Function, find-slot-by-the-name: Private ordinary functions
Function, get-extension: Public ordinary functions
Function, image-pathname: Public ordinary functions
Function, image-url: Public ordinary functions
Function, make-clipper-config: Private ordinary functions
Function, read-image-to-vector: Public ordinary functions
Function, setup-clipper: Public ordinary functions
Function, store-format: Public ordinary functions
Function, temporary-file-template: Private ordinary functions
Function, upload: Public ordinary functions
Function, write-image-to-out: Public ordinary functions

G
Generic Function, attach-image: Public generic functions
Generic Function, retrieve-url: Public generic functions
Generic Function, store-image: Public generic functions
get-extension: Public ordinary functions

I
image-pathname: Public ordinary functions
image-url: Public ordinary functions

M
make-clipper-config: Private ordinary functions
Method, access-key: Public standalone methods
Method, attach-image: Public generic functions
Method, attach-image: Public generic functions
Method, retrieve-url: Public generic functions
Method, retrieve-url: Public generic functions
Method, secret-key: Public standalone methods
Method, store-image: Public generic functions
Method, store-image: Public generic functions
Method, store-image: Public generic functions
Method, store-image: Public generic functions

R
read-image-to-vector: Public ordinary functions
retrieve-url: Public generic functions
retrieve-url: Public generic functions
retrieve-url: Public generic functions

S
secret-key: Public standalone methods
setup-clipper: Public ordinary functions
store-format: Public ordinary functions
store-image: Public generic functions
store-image: Public generic functions
store-image: Public generic functions
store-image: Public generic functions
store-image: Public generic functions

T
temporary-file-template: Private ordinary functions

U
upload: Public ordinary functions

W
write-image-to-out: Public ordinary functions


A.3 Variables

Jump to:   *  
A   C   F   H   I   O   P   R   S   T   U   W  
Index Entry  Section

*
*clipper-config*: Public special variables
*format-keys*: Public special variables
*local-requrie-list*: Private special variables
*s3-require-list*: Private special variables
*supported-content-types*: Public special variables

A
args: Public conditions
aws-access-key: Public structures
aws-secret-key: Public structures

C
clipper-class: Public structures
content-type: Public conditions

F
format: Public structures

H
height: Public structures

I
id-slot: Public structures
image-content-type-slot: Public structures
image-directory: Public structures
image-file-name-slot: Public structures
image-file-size-slot: Public structures

O
object: Public conditions

P
prefix: Public structures

R
relative: Public structures

S
s3-bucket-name: Public structures
s3-endpoint: Public structures
Slot, args: Public conditions
Slot, aws-access-key: Public structures
Slot, aws-secret-key: Public structures
Slot, clipper-class: Public structures
Slot, content-type: Public conditions
Slot, format: Public structures
Slot, height: Public structures
Slot, id-slot: Public structures
Slot, image-content-type-slot: Public structures
Slot, image-directory: Public structures
Slot, image-file-name-slot: Public structures
Slot, image-file-size-slot: Public structures
Slot, object: Public conditions
Slot, prefix: Public structures
Slot, relative: Public structures
Slot, s3-bucket-name: Public structures
Slot, s3-endpoint: Public structures
Slot, slot-list: Public conditions
Slot, store-type: Public structures
Slot, type: Public conditions
Slot, type: Public conditions
Slot, type: Public conditions
Slot, url-slot: Public structures
Slot, width: Public structures
slot-list: Public conditions
Special Variable, *clipper-config*: Public special variables
Special Variable, *format-keys*: Public special variables
Special Variable, *local-requrie-list*: Private special variables
Special Variable, *s3-require-list*: Private special variables
Special Variable, *supported-content-types*: Public special variables
store-type: Public structures

T
type: Public conditions
type: Public conditions
type: Public conditions

U
url-slot: Public structures

W
width: Public structures


A.4 Data types

Jump to:   <  
C   D   E   F   I   L   M   P   S  
Index Entry  Section

<
<clipper-error>: Public conditions
<clipper-image-type-error>: Public conditions
<clipper-incomplete-config>: Public conditions
<clipper-incomplete-for-attach-image>: Public conditions
<clipper-incomplete-local-config>: Public conditions
<clipper-incomplete-s3-config>: Public conditions
<clipper-invalid-store-type>: Public conditions
<clipper-no-source-specified>: Public conditions
<clipper-unsupported-content-type>: Public conditions

C
Class, environment-credentials: Private classes
clipper: The clipper system
clipper: The clipper package
clipper-asd: The clipper-asd package
clipper-config: Public structures
clipper.asd: The clipper/clipper․asd file
clipper.config: The clipper․config package
clipper.database: The clipper․database package
clipper.error: The clipper․error package
clipper.format: The clipper․format package
clipper.image: The clipper․image package
clipper.lisp: The clipper/src/clipper․lisp file
clipper.local: The clipper․local package
clipper.s3: The clipper․s3 package
Condition, <clipper-error>: Public conditions
Condition, <clipper-image-type-error>: Public conditions
Condition, <clipper-incomplete-config>: Public conditions
Condition, <clipper-incomplete-for-attach-image>: Public conditions
Condition, <clipper-incomplete-local-config>: Public conditions
Condition, <clipper-incomplete-s3-config>: Public conditions
Condition, <clipper-invalid-store-type>: Public conditions
Condition, <clipper-no-source-specified>: Public conditions
Condition, <clipper-unsupported-content-type>: Public conditions
config.lisp: The clipper/src/config․lisp file

D
database.lisp: The clipper/src/database․lisp file

E
environment-credentials: Private classes
error.lisp: The clipper/src/error․lisp file

F
File, clipper.asd: The clipper/clipper․asd file
File, clipper.lisp: The clipper/src/clipper․lisp file
File, config.lisp: The clipper/src/config․lisp file
File, database.lisp: The clipper/src/database․lisp file
File, error.lisp: The clipper/src/error․lisp file
File, format.lisp: The clipper/src/format․lisp file
File, image.lisp: The clipper/src/image․lisp file
File, local.lisp: The clipper/src/local․lisp file
File, s3.lisp: The clipper/src/s3․lisp file
format.lisp: The clipper/src/format․lisp file

I
image.lisp: The clipper/src/image․lisp file

L
local.lisp: The clipper/src/local․lisp file

M
Module, src: The clipper/src module

P
Package, clipper: The clipper package
Package, clipper-asd: The clipper-asd package
Package, clipper.config: The clipper․config package
Package, clipper.database: The clipper․database package
Package, clipper.error: The clipper․error package
Package, clipper.format: The clipper․format package
Package, clipper.image: The clipper․image package
Package, clipper.local: The clipper․local package
Package, clipper.s3: The clipper․s3 package

S
s3.lisp: The clipper/src/s3․lisp file
src: The clipper/src module
Structure, clipper-config: Public structures
System, clipper: The clipper system