The sane Reference Manual

Table of Contents

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

The sane Reference Manual

This is the sane Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:22:04 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 sane

Author

Rupert Swarbrick <rswarbrick@gmail.com>

License

GPLv3

Description

Lispy library bindings for sane.

Dependencies
Source

sane.asd (file)

Components

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

2 Modules

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


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

2.1 sane/swig

Dependency

package.lisp (file)

Parent

sane (system)

Location

swig/

Component

sane-lowlevel.lisp (file)


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

2.2 sane/src

Dependencies
Parent

sane (system)

Location

src/

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 sane.asd

Location

sane.asd

Systems

sane (system)

Packages

sane-asdf

Internal Definitions

swig-generated-source (class)


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

3.1.2 sane/package.lisp

Parent

sane (system)

Location

package.lisp

Packages

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

3.1.3 sane/swig/sane-lowlevel.lisp

Parent

swig (module)

Location

swig/sane-lowlevel.lisp

Internal Definitions

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

3.1.4 sane/src/devices.lisp

Parent

src (module)

Location

src/devices.lisp

Exported Definitions
Internal Definitions

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

3.1.5 sane/src/library.lisp

Dependency

utilities.lisp (file)

Parent

src (module)

Location

src/library.lisp

Exported Definitions
Internal Definitions

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

3.1.6 sane/src/options.lisp

Dependency

devices.lisp (file)

Parent

src (module)

Location

src/options.lisp

Exported Definitions
Internal Definitions

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

3.1.7 sane/src/parameters.lisp

Dependency

devices.lisp (file)

Parent

src (module)

Location

src/parameters.lisp

Exported Definitions

parameters (class)

Internal Definitions

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

3.1.8 sane/src/read.lisp

Dependencies
Parent

src (module)

Location

src/read.lisp

Exported Definitions
Internal Definitions

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

3.1.9 sane/src/debug.lisp

Dependency

devices.lisp (file)

Parent

src (module)

Location

src/debug.lisp

Exported Definitions

dump-option-list (method)


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

3.1.10 sane/src/utilities.lisp

Parent

src (module)

Location

src/utilities.lisp

Exported Definitions

ensure-ok (macro)


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

4 Packages

Packages are listed by definition order.


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

4.1 sane-asdf

Source

sane.asd

Use List
Internal Definitions

swig-generated-source (class)


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

4.2 sane

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

4.3 sane-lowlevel

Source

package.lisp (file)

Use List
Used By List

sane

Exported Definitions

ensure-ok (macro)

Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Macros

Macro: ensure-ok FORM &rest ERR_FORMAT

Run FORM and ensure it evaluates to :SANE_STATUS_GOOD. If not, throw an error, with message ERR_FORMAT if defined. A description of the error is appended in this case.

Package

sane-lowlevel

Source

utilities.lisp (file)

Macro: with-device DEV-SYM DEV-REF &body FORMS

Evaluate FORMS with DEVICE bound to the sane device referred to by DEV-REF within a progn. This can either be the nil, the name of a device or a non-negative integer.

If DEV-REF is the name of a device then DEVICE is bound to the device of that name (if it exists!). If DEV-REF is an integer, DEVICE is bound to the DEV-REF’th device returned by sane-devices. If DEV-REF is nil, then DEVICE is bound to the first element from that list.

DEV-REF (and FORMS!) are only evaluated once.

Package

sane

Source

devices.lisp (file)

Macro: with-init VERSION-SYM &body BODY

Run BODY with VERSION-SYM set to a triple representing the version of libsane that is running. Evaluates to BODY. If VERSION-SYM is nil, there is no symbol bound to the version.

Package

sane

Source

library.lisp (file)

Macro: with-open-scanner-stream STREAM DEVICE &body FORMS

Open up a binary gray stream STREAM reading from DEVICE and execute FORMS with it open.

Package

sane

Source

read.lisp (file)


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

5.1.2 Functions

Function: devices &optional LOCAL-ONLY FORCE-UPDATE

Read the list of sane-accessible devices. If LOCAL-ONLY, then only look for devices local to the machine. If FORCE-UPDATE, search again, whether or not we’ve done it already.

Package

sane

Source

devices.lisp (file)

Function: option-value-readable-p CAPABILITIES

Predicate to test whether we can read the value of the option. This is possible if soft-detect and not inactive.

Package

sane

Source

options.lisp (file)

Function: sane-ref ()

Initialise the SANE library and return a triple returning the current version of libsane. Add a reference to the library structures.

Package

sane

Source

library.lisp (file)

Function: sane-unref ()

Decrement SANE reference count and free memory structures relating to the SANE library if count is zero.

Package

sane

Source

library.lisp (file)


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

5.1.3 Generic functions

Generic Function: device OBJECT
Package

sane

Methods
Method: device (SANE-BLOCKING-STREAM sane-blocking-stream)

automatically generated reader method

Source

read.lisp (file)

Generic Function: device-option OPTSPEC DEVICE

Read an option from a device. DEVICE should be the SANE device from which to read the option and OPTSPEC should be either an integer index or a string name for the option.

Package

sane

Source

options.lisp (file)

Methods
Method: device-option (NAME string) (DEVICE device)

Access an option of DEVICE by name.

Method: device-option (N integer) (DEVICE device)

Access an option of DEVICE by position.

Generic Function: device-type OBJECT
Package

sane

Methods
Method: device-type (DEVICE device)

automatically generated reader method

Source

devices.lisp (file)

Generic Function: dump-option-list D &optional STREAM
Package

sane

Methods
Method: dump-option-list (D device) &optional STREAM
Source

debug.lisp (file)

Generic Function: get-capabilities OBJECT
Package

sane

Methods
Method: get-capabilities (OPTION option)

automatically generated reader method

Source

options.lisp (file)

Generic Function: get-constraint OBJECT
Generic Function: (setf get-constraint) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-constraint (OPTION-VALUE option-value)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-constraint) NEW-VALUE (OPTION-VALUE option-value)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-description OBJECT
Generic Function: (setf get-description) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-description (OPTIONOID optionoid)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-description) NEW-VALUE (OPTIONOID optionoid)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-device OBJECT
Generic Function: (setf get-device) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-device (OPTIONOID optionoid)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-device) NEW-VALUE (OPTIONOID optionoid)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-list OBJECT
Generic Function: (setf get-list) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-list (LIST-CONSTRAINT list-constraint)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-list) NEW-VALUE (LIST-CONSTRAINT list-constraint)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-max OBJECT
Generic Function: (setf get-max) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-max (RANGE-CONSTRAINT range-constraint)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-max) NEW-VALUE (RANGE-CONSTRAINT range-constraint)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-min OBJECT
Generic Function: (setf get-min) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-min (RANGE-CONSTRAINT range-constraint)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-min) NEW-VALUE (RANGE-CONSTRAINT range-constraint)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-name OBJECT
Generic Function: (setf get-name) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-name (OPTIONOID optionoid)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-name) NEW-VALUE (OPTIONOID optionoid)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-step OBJECT
Generic Function: (setf get-step) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-step (RANGE-CONSTRAINT range-constraint)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-step) NEW-VALUE (RANGE-CONSTRAINT range-constraint)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-title OBJECT
Generic Function: (setf get-title) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-title (OPTIONOID optionoid)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-title) NEW-VALUE (OPTIONOID optionoid)

automatically generated writer method

Source

options.lisp (file)

Generic Function: model OBJECT
Package

sane

Methods
Method: model (DEVICE device)

automatically generated reader method

Source

devices.lisp (file)

Generic Function: name OBJECT
Package

sane

Methods
Method: name (DEVICE device)

automatically generated reader method

Source

devices.lisp (file)

Generic Function: option-value OPT

Get a (possibly cached) value that was set for the option OPT.

Package

sane

Source

options.lisp (file)

Setf Expander

(setf option-value) (setf expander)

Methods
Method: option-value (OPTION option)
Setf Expander: (setf option-value) OPTION
Package

sane

Source

options.lisp (file)

Reader

option-value (generic function)

Generic Function: parameters OBJECT
Package

sane

Methods
Method: parameters (SANE-BLOCKING-STREAM sane-blocking-stream)

automatically generated reader method

Source

read.lisp (file)

Generic Function: vendor OBJECT
Package

sane

Methods
Method: vendor (DEVICE device)

automatically generated reader method

Source

devices.lisp (file)


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

5.1.4 Classes

Class: device ()
Package

sane

Source

devices.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Slot: vendor
Initargs

:vendor

Readers

vendor (generic function)

Slot: model
Initargs

:model

Readers

model (generic function)

Slot: type
Initargs

:type

Readers

device-type (generic function)

Slot: handle
Initargs

:handle

Readers

handle (generic function)

Writers

(setf handle) (generic function)

Slot: options
Slot: groups
Slot: options-hash
Class: option ()
Package

sane

Source

options.lisp (file)

Direct superclasses

optionoid (class)

Direct methods
Direct slots
Slot: value
Initargs

:value

Slot: capabilities
Initargs

:capabilities

Readers

get-capabilities (generic function)

Class: option-value ()
Package

sane

Source

options.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: type
Initargs

:type

Readers

get-type (generic function)

Writers

(setf get-type) (generic function)

Slot: dirty
Initform

t

Readers

get-dirty (generic function)

Writers

(setf get-dirty) (generic function)

Slot: constraint
Initargs

:constraint

Readers

get-constraint (generic function)

Writers

(setf get-constraint) (generic function)

Slot: unit
Initargs

:unit

Slot: value
Slot: c-size
Initargs

:c-size

Class: parameters ()
Package

sane

Source

parameters.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: format
Initargs

:format

Readers

get-format (generic function)

Slot: last-frame
Initargs

:last-frame

Readers

last-frame-p (generic function)

Slot: bytes-per-line
Initargs

:bytes-per-line

Readers

get-bytes-per-line (generic function)

Slot: pixels-per-line
Initargs

:pixels-per-line

Readers

get-pixels-per-line (generic function)

Slot: lines
Initargs

:lines

Readers

get-lines (generic function)

Slot: depth
Initargs

:depth

Readers

get-depth (generic function)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: sane_cap_advanced
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_cap_automatic
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_cap_emulated
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_cap_hard_select
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_cap_inactive
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_cap_soft_detect
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_cap_soft_select
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_current_major
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_current_minor
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_false
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_fixed_scale_shift
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_info_inexact
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_info_reload_options
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_info_reload_params
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_max_password_len
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_max_username_len
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Constant: sane_true
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)


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

5.2.2 Special variables

Special Variable: *device-list*

Cached list of sane devices

Package

sane

Source

devices.lisp (file)

Special Variable: *sane-references*
Package

sane

Source

library.lisp (file)

Special Variable: *sane-version*
Package

sane

Source

library.lisp (file)


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

5.2.3 Macros

Macro: defanonenum &body ENUMS

Converts anonymous enums to defconstants.

Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Macro: make-set-option-value-vector FOREIGN-TYPE LISP-TYPE TXFORM
Package

sane

Source

options.lisp (file)


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

5.2.4 Functions

Function: actually-set-option-value OPTION MEMORY

Finally make the call to SANE to set the option value. Dirties parameters etc if necessary and checks for errors.

Package

sane

Source

options.lisp (file)

Function: calc-device-string REF

Calculates the correct string to use to open the device with sane_open. nil gives the first device. An integer n gives the n’th device. A device gives the device name. A string is left alone.

Package

sane

Source

devices.lisp (file)

Function: copy-device D
Package

sane

Source

devices.lisp (file)

Function: device-from-ptr DEVICE-PTR

Constructs a device structure from the pointer DEVICE-PTR

Package

sane

Source

devices.lisp (file)

Function: device-p D
Package

sane

Source

devices.lisp (file)

Function: foreign-strings-to-lisp POINTER &optional LENGTH

Suppose POINTER points to an array of pointers, each of which points at a string. Evaluate to a list containing these strings. If LENGTH is given, use that, else assume the array is null-terminated.

Package

sane

Source

options.lisp (file)

Function: get-parameters DEVICE

Read parameters from DEVICE: evaluates to an instance of SANE::PARAMETERS

Package

sane

Source

parameters.lisp (file)

Function: lispify-constraint TYPE CONSTRAINT

Parse a libsane constraint pointed to by CONSTRAINT of type TYPE into something more pleasant: one of the sane::constraint heirarchy.

Package

sane

Source

options.lisp (file)

Function: lispify-sane-capabilities CAPS
Package

sane

Source

options.lisp (file)

Function: lispify-sane-frame-format FMT
Package

sane

Source

parameters.lisp (file)

Function: read-devices LOCAL-ONLY

Read list of sane-accessible devices.

Package

sane

Source

devices.lisp (file)

Function: read-option-value DEVICE POSITION TYPE SIZE

Actually read the value of an option from DEVICE. Read the option at POSITION, which has TYPE and is length SIZE. This is an internal-ish function called by recalculate-options-list.

Package

sane

Source

options.lisp (file)

Function: recalculate-options-list DEVICE

Read the options list from the device. Groups get placed in a list of groups and options in a list (and hash-table) of options. DEVICE is a sane::device btw.

Package

sane

Source

options.lisp (file)

Function: refill-buffer! BUFFER HANDLE LENGTH
Package

sane

Source

read.lisp (file)

Function: sane-interpret-version N

Read bitstring for version and output the correct major/minor/rev version

Package

sane

Source

library.lisp (file)

Function: sane_cancel HANDLE
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_close HANDLE
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_control_option HANDLE OPTION ACTION VALUE INFO
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_exit ()
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_get_devices DEVICE_LIST LOCAL_ONLY
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_get_option_descriptor HANDLE OPTION
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_get_parameters HANDLE PARAMS
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_get_select_fd HANDLE FD
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_init VERSION_CODE AUTHORIZE
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_open DEVICENAME HANDLE
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_read HANDLE DATA MAX_LENGTH LENGTH
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_set_io_mode HANDLE NON_BLOCKING
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_start HANDLE
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: sane_strstatus STATUS
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: swig-lispify NAME FLAG &optional PACKAGE
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Function: update-option-value OPTION

Read the value of an option from the device.

Package

sane

Source

options.lisp (file)


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

5.2.5 Generic functions

Generic Function: device-groups DEVICE

Return a list of the groups for a device

Package

sane

Source

options.lisp (file)

Methods
Method: device-groups (D device)
Generic Function: get-bytes-per-line OBJECT
Package

sane

Methods
Method: get-bytes-per-line (PARAMETERS parameters)

automatically generated reader method

Source

parameters.lisp (file)

Generic Function: get-depth OBJECT
Package

sane

Methods
Method: get-depth (PARAMETERS parameters)

automatically generated reader method

Source

parameters.lisp (file)

Generic Function: get-dirty OBJECT
Generic Function: (setf get-dirty) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-dirty (OPTION-VALUE option-value)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-dirty) NEW-VALUE (OPTION-VALUE option-value)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-format OBJECT
Package

sane

Methods
Method: get-format (PARAMETERS parameters)

automatically generated reader method

Source

parameters.lisp (file)

Generic Function: get-lines OBJECT
Package

sane

Methods
Method: get-lines (PARAMETERS parameters)

automatically generated reader method

Source

parameters.lisp (file)

Generic Function: get-pixels-per-line OBJECT
Package

sane

Methods
Method: get-pixels-per-line (PARAMETERS parameters)

automatically generated reader method

Source

parameters.lisp (file)

Generic Function: get-position OBJECT
Generic Function: (setf get-position) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-position (OPTIONOID optionoid)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-position) NEW-VALUE (OPTIONOID optionoid)

automatically generated writer method

Source

options.lisp (file)

Generic Function: get-type OBJECT
Generic Function: (setf get-type) NEW-VALUE OBJECT
Package

sane

Methods
Method: get-type (OPTION-VALUE option-value)

automatically generated reader method

Source

options.lisp (file)

Method: (setf get-type) NEW-VALUE (OPTION-VALUE option-value)

automatically generated writer method

Source

options.lisp (file)

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

sane

Methods
Method: handle (DEVICE device)

automatically generated reader method

Source

devices.lisp (file)

Method: (setf handle) NEW-VALUE (DEVICE device)

automatically generated writer method

Source

devices.lisp (file)

Generic Function: last-frame-p OBJECT
Package

sane

Methods
Method: last-frame-p (PARAMETERS parameters)

automatically generated reader method

Source

parameters.lisp (file)

Generic Function: set-option-value TYPE OPTION VALUE

Store a value in an option. Accessible via the OPTION-VALUE setf.

Package

sane

Source

options.lisp (file)

Methods
Method: set-option-value (TYPE (eql sane_type_bool)) (OPTION option) NEW-VALUE

Set the value of an option expecting a bool.

Method: set-option-value (TYPE (eql sane_type_fixed)) (OPTION option) NEW-VALUE
Method: set-option-value (TYPE (eql sane_type_int)) (OPTION option) NEW-VALUE
Method: set-option-value (TYPE (eql sane_type_string)) (OPTION option) NEW-VALUE

Set the value of an option expecting a string.

Generic Function: stream-open STREAM
Package

sane

Methods
Method: stream-open (STREAM sane-blocking-stream)

Open the scanner as a stream. After this operation, the PARAMETERS slot is valid on STREAM.

Source

read.lisp (file)

Method: stream-open (STREAM blockwise-binary-input-stream)

On the superclass, this is a no-op.

Source

read.lisp (file)

Method: stream-open STREAM
Source

read.lisp (file)


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

5.2.6 Classes

Class: blockwise-binary-input-stream ()

This is an input stream that reads input from a function, REFILL-BUFFER-FUNCTION, which has the signature

(REFILL-BUFFER-FUNCTION buffer length)

where BUFFER is an array of length LENGTH. The function must return two values: the number of bytes read and nil/t depending on whether we’ve got to eof.

There is a STREAM-READ-BYTE function specialized on this class, which ’does the right thing’.

Package

sane

Source

read.lisp (file)

Direct superclasses

trivial-gray-stream-mixin (class)

Direct subclasses

sane-blocking-stream (class)

Direct methods
  • stream-read-byte (method)
  • stream-open (method)
  • initialize-instance (method)
Direct slots
Slot: refill-buffer-function
Slot: buflen
Initargs

:buflen

Initform

256

Slot: buffer
Slot: buffer-fill
Initform

0

Slot: buffer-pointer
Initform

0

Slot: eof
Class: constraint ()
Package

sane

Source

options.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: group ()
Package

sane

Source

options.lisp (file)

Direct superclasses

optionoid (class)

Direct methods

print-object (method)

Direct slots
Slot: group-end-pos
Slot: group-start-pos
Initargs

:group-start-pos

Class: list-constraint ()
Package

sane

Source

options.lisp (file)

Direct superclasses

constraint (class)

Direct methods
Direct slots
Slot: list
Initargs

:list

Readers

get-list (generic function)

Writers

(setf get-list) (generic function)

Class: optionoid ()
Package

sane

Source

options.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

get-name (generic function)

Writers

(setf get-name) (generic function)

Slot: title
Initargs

:title

Readers

get-title (generic function)

Writers

(setf get-title) (generic function)

Slot: description
Initargs

:description

Readers

get-description (generic function)

Writers

(setf get-description) (generic function)

Slot: position
Initargs

:position

Readers

get-position (generic function)

Writers

(setf get-position) (generic function)

Slot: device
Initargs

:device

Readers

get-device (generic function)

Writers

(setf get-device) (generic function)

Class: range-constraint ()
Package

sane

Source

options.lisp (file)

Direct superclasses

constraint (class)

Direct methods
Direct slots
Slot: min
Initargs

:min

Readers

get-min (generic function)

Writers

(setf get-min) (generic function)

Slot: step
Initargs

:step

Readers

get-step (generic function)

Writers

(setf get-step) (generic function)

Slot: max
Initargs

:max

Readers

get-max (generic function)

Writers

(setf get-max) (generic function)

Class: sane-blocking-stream ()

SANE-BLOCKING-STREAM masks reading from a scanner device as reading from a stream. Once STREAM-OPEN has been called on the stream, the PARAMETERS slot will contain an instance of the SANE::PARAMETERS class valid for the scanner. In particular, since sane_start will have been called, the members will be valid at this point.

Package

sane

Source

read.lisp (file)

Direct superclasses

blockwise-binary-input-stream (class)

Direct methods
Direct slots
Slot: device
Initargs

:device

Readers

device (generic function)

Slot: parameters
Readers

parameters (generic function)

Class: sane_device-tclass ()
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sane_option_descriptor-tclass ()
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sane_parameters-tclass ()
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sane_range-tclass ()
Package

sane-lowlevel

Source

sane-lowlevel.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: swig-generated-source ()
Package

sane-asdf

Source

sane.asd

Direct superclasses

cl-source-file (class)

Direct methods

perform (method)

Class: trivial-constraint ()
Package

sane

Source

options.lisp (file)

Direct superclasses

constraint (class)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

F
File, Lisp, sane.asd: The sane<dot>asd file
File, Lisp, sane/package.lisp: The sane/package<dot>lisp file
File, Lisp, sane/src/debug.lisp: The sane/src/debug<dot>lisp file
File, Lisp, sane/src/devices.lisp: The sane/src/devices<dot>lisp file
File, Lisp, sane/src/library.lisp: The sane/src/library<dot>lisp file
File, Lisp, sane/src/options.lisp: The sane/src/options<dot>lisp file
File, Lisp, sane/src/parameters.lisp: The sane/src/parameters<dot>lisp file
File, Lisp, sane/src/read.lisp: The sane/src/read<dot>lisp file
File, Lisp, sane/src/utilities.lisp: The sane/src/utilities<dot>lisp file
File, Lisp, sane/swig/sane-lowlevel.lisp: The sane/swig/sane-lowlevel<dot>lisp file

L
Lisp File, sane.asd: The sane<dot>asd file
Lisp File, sane/package.lisp: The sane/package<dot>lisp file
Lisp File, sane/src/debug.lisp: The sane/src/debug<dot>lisp file
Lisp File, sane/src/devices.lisp: The sane/src/devices<dot>lisp file
Lisp File, sane/src/library.lisp: The sane/src/library<dot>lisp file
Lisp File, sane/src/options.lisp: The sane/src/options<dot>lisp file
Lisp File, sane/src/parameters.lisp: The sane/src/parameters<dot>lisp file
Lisp File, sane/src/read.lisp: The sane/src/read<dot>lisp file
Lisp File, sane/src/utilities.lisp: The sane/src/utilities<dot>lisp file
Lisp File, sane/swig/sane-lowlevel.lisp: The sane/swig/sane-lowlevel<dot>lisp file

M
Module, sane/src: The sane/src module
Module, sane/swig: The sane/swig module

S
sane.asd: The sane<dot>asd file
sane/package.lisp: The sane/package<dot>lisp file
sane/src: The sane/src module
sane/src/debug.lisp: The sane/src/debug<dot>lisp file
sane/src/devices.lisp: The sane/src/devices<dot>lisp file
sane/src/library.lisp: The sane/src/library<dot>lisp file
sane/src/options.lisp: The sane/src/options<dot>lisp file
sane/src/parameters.lisp: The sane/src/parameters<dot>lisp file
sane/src/read.lisp: The sane/src/read<dot>lisp file
sane/src/utilities.lisp: The sane/src/utilities<dot>lisp file
sane/swig: The sane/swig module
sane/swig/sane-lowlevel.lisp: The sane/swig/sane-lowlevel<dot>lisp file

Jump to:   F   L   M   S  

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

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   L   M   N   O   P   R   S   U   V   W  
Index Entry  Section

(
(setf get-constraint): Exported generic functions
(setf get-constraint): Exported generic functions
(setf get-description): Exported generic functions
(setf get-description): Exported generic functions
(setf get-device): Exported generic functions
(setf get-device): Exported generic functions
(setf get-dirty): Internal generic functions
(setf get-dirty): Internal generic functions
(setf get-list): Exported generic functions
(setf get-list): Exported generic functions
(setf get-max): Exported generic functions
(setf get-max): Exported generic functions
(setf get-min): Exported generic functions
(setf get-min): Exported generic functions
(setf get-name): Exported generic functions
(setf get-name): Exported generic functions
(setf get-position): Internal generic functions
(setf get-position): Internal generic functions
(setf get-step): Exported generic functions
(setf get-step): Exported generic functions
(setf get-title): Exported generic functions
(setf get-title): Exported generic functions
(setf get-type): Internal generic functions
(setf get-type): Internal generic functions
(setf handle): Internal generic functions
(setf handle): Internal generic functions
(setf option-value): Exported generic functions

A
actually-set-option-value: Internal functions

C
calc-device-string: Internal functions
copy-device: Internal functions

D
defanonenum: Internal macros
device: Exported generic functions
device: Exported generic functions
device-from-ptr: Internal functions
device-groups: Internal generic functions
device-groups: Internal generic functions
device-option: Exported generic functions
device-option: Exported generic functions
device-option: Exported generic functions
device-p: Internal functions
device-type: Exported generic functions
device-type: Exported generic functions
devices: Exported functions
dump-option-list: Exported generic functions
dump-option-list: Exported generic functions

E
ensure-ok: Exported macros

F
foreign-strings-to-lisp: Internal functions
Function, actually-set-option-value: Internal functions
Function, calc-device-string: Internal functions
Function, copy-device: Internal functions
Function, device-from-ptr: Internal functions
Function, device-p: Internal functions
Function, devices: Exported functions
Function, foreign-strings-to-lisp: Internal functions
Function, get-parameters: Internal functions
Function, lispify-constraint: Internal functions
Function, lispify-sane-capabilities: Internal functions
Function, lispify-sane-frame-format: Internal functions
Function, option-value-readable-p: Exported functions
Function, read-devices: Internal functions
Function, read-option-value: Internal functions
Function, recalculate-options-list: Internal functions
Function, refill-buffer!: Internal functions
Function, sane-interpret-version: Internal functions
Function, sane-ref: Exported functions
Function, sane-unref: Exported functions
Function, sane_cancel: Internal functions
Function, sane_close: Internal functions
Function, sane_control_option: Internal functions
Function, sane_exit: Internal functions
Function, sane_get_devices: Internal functions
Function, sane_get_option_descriptor: Internal functions
Function, sane_get_parameters: Internal functions
Function, sane_get_select_fd: Internal functions
Function, sane_init: Internal functions
Function, sane_open: Internal functions
Function, sane_read: Internal functions
Function, sane_set_io_mode: Internal functions
Function, sane_start: Internal functions
Function, sane_strstatus: Internal functions
Function, swig-lispify: Internal functions
Function, update-option-value: Internal functions

G
Generic Function, (setf get-constraint): Exported generic functions
Generic Function, (setf get-description): Exported generic functions
Generic Function, (setf get-device): Exported generic functions
Generic Function, (setf get-dirty): Internal generic functions
Generic Function, (setf get-list): Exported generic functions
Generic Function, (setf get-max): Exported generic functions
Generic Function, (setf get-min): Exported generic functions
Generic Function, (setf get-name): Exported generic functions
Generic Function, (setf get-position): Internal generic functions
Generic Function, (setf get-step): Exported generic functions
Generic Function, (setf get-title): Exported generic functions
Generic Function, (setf get-type): Internal generic functions
Generic Function, (setf handle): Internal generic functions
Generic Function, device: Exported generic functions
Generic Function, device-groups: Internal generic functions
Generic Function, device-option: Exported generic functions
Generic Function, device-type: Exported generic functions
Generic Function, dump-option-list: Exported generic functions
Generic Function, get-bytes-per-line: Internal generic functions
Generic Function, get-capabilities: Exported generic functions
Generic Function, get-constraint: Exported generic functions
Generic Function, get-depth: Internal generic functions
Generic Function, get-description: Exported generic functions
Generic Function, get-device: Exported generic functions
Generic Function, get-dirty: Internal generic functions
Generic Function, get-format: Internal generic functions
Generic Function, get-lines: Internal generic functions
Generic Function, get-list: Exported generic functions
Generic Function, get-max: Exported generic functions
Generic Function, get-min: Exported generic functions
Generic Function, get-name: Exported generic functions
Generic Function, get-pixels-per-line: Internal generic functions
Generic Function, get-position: Internal generic functions
Generic Function, get-step: Exported generic functions
Generic Function, get-title: Exported generic functions
Generic Function, get-type: Internal generic functions
Generic Function, handle: Internal generic functions
Generic Function, last-frame-p: Internal generic functions
Generic Function, model: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, option-value: Exported generic functions
Generic Function, parameters: Exported generic functions
Generic Function, set-option-value: Internal generic functions
Generic Function, stream-open: Internal generic functions
Generic Function, vendor: Exported generic functions
get-bytes-per-line: Internal generic functions
get-bytes-per-line: Internal generic functions
get-capabilities: Exported generic functions
get-capabilities: Exported generic functions
get-constraint: Exported generic functions
get-constraint: Exported generic functions
get-depth: Internal generic functions
get-depth: Internal generic functions
get-description: Exported generic functions
get-description: Exported generic functions
get-device: Exported generic functions
get-device: Exported generic functions
get-dirty: Internal generic functions
get-dirty: Internal generic functions
get-format: Internal generic functions
get-format: Internal generic functions
get-lines: Internal generic functions
get-lines: Internal generic functions
get-list: Exported generic functions
get-list: Exported generic functions
get-max: Exported generic functions
get-max: Exported generic functions
get-min: Exported generic functions
get-min: Exported generic functions
get-name: Exported generic functions
get-name: Exported generic functions
get-parameters: Internal functions
get-pixels-per-line: Internal generic functions
get-pixels-per-line: Internal generic functions
get-position: Internal generic functions
get-position: Internal generic functions
get-step: Exported generic functions
get-step: Exported generic functions
get-title: Exported generic functions
get-title: Exported generic functions
get-type: Internal generic functions
get-type: Internal generic functions

H
handle: Internal generic functions
handle: Internal generic functions

L
last-frame-p: Internal generic functions
last-frame-p: Internal generic functions
lispify-constraint: Internal functions
lispify-sane-capabilities: Internal functions
lispify-sane-frame-format: Internal functions

M
Macro, defanonenum: Internal macros
Macro, ensure-ok: Exported macros
Macro, make-set-option-value-vector: Internal macros
Macro, with-device: Exported macros
Macro, with-init: Exported macros
Macro, with-open-scanner-stream: Exported macros
make-set-option-value-vector: Internal macros
Method, (setf get-constraint): Exported generic functions
Method, (setf get-description): Exported generic functions
Method, (setf get-device): Exported generic functions
Method, (setf get-dirty): Internal generic functions
Method, (setf get-list): Exported generic functions
Method, (setf get-max): Exported generic functions
Method, (setf get-min): Exported generic functions
Method, (setf get-name): Exported generic functions
Method, (setf get-position): Internal generic functions
Method, (setf get-step): Exported generic functions
Method, (setf get-title): Exported generic functions
Method, (setf get-type): Internal generic functions
Method, (setf handle): Internal generic functions
Method, device: Exported generic functions
Method, device-groups: Internal generic functions
Method, device-option: Exported generic functions
Method, device-option: Exported generic functions
Method, device-type: Exported generic functions
Method, dump-option-list: Exported generic functions
Method, get-bytes-per-line: Internal generic functions
Method, get-capabilities: Exported generic functions
Method, get-constraint: Exported generic functions
Method, get-depth: Internal generic functions
Method, get-description: Exported generic functions
Method, get-device: Exported generic functions
Method, get-dirty: Internal generic functions
Method, get-format: Internal generic functions
Method, get-lines: Internal generic functions
Method, get-list: Exported generic functions
Method, get-max: Exported generic functions
Method, get-min: Exported generic functions
Method, get-name: Exported generic functions
Method, get-pixels-per-line: Internal generic functions
Method, get-position: Internal generic functions
Method, get-step: Exported generic functions
Method, get-title: Exported generic functions
Method, get-type: Internal generic functions
Method, handle: Internal generic functions
Method, last-frame-p: Internal generic functions
Method, model: Exported generic functions
Method, name: Exported generic functions
Method, option-value: Exported generic functions
Method, parameters: Exported generic functions
Method, set-option-value: Internal generic functions
Method, set-option-value: Internal generic functions
Method, set-option-value: Internal generic functions
Method, set-option-value: Internal generic functions
Method, stream-open: Internal generic functions
Method, stream-open: Internal generic functions
Method, stream-open: Internal generic functions
Method, vendor: Exported generic functions
model: Exported generic functions
model: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions

O
option-value: Exported generic functions
option-value: Exported generic functions
option-value-readable-p: Exported functions

P
parameters: Exported generic functions
parameters: Exported generic functions

R
read-devices: Internal functions
read-option-value: Internal functions
recalculate-options-list: Internal functions
refill-buffer!: Internal functions

S
sane-interpret-version: Internal functions
sane-ref: Exported functions
sane-unref: Exported functions
sane_cancel: Internal functions
sane_close: Internal functions
sane_control_option: Internal functions
sane_exit: Internal functions
sane_get_devices: Internal functions
sane_get_option_descriptor: Internal functions
sane_get_parameters: Internal functions
sane_get_select_fd: Internal functions
sane_init: Internal functions
sane_open: Internal functions
sane_read: Internal functions
sane_set_io_mode: Internal functions
sane_start: Internal functions
sane_strstatus: Internal functions
set-option-value: Internal generic functions
set-option-value: Internal generic functions
set-option-value: Internal generic functions
set-option-value: Internal generic functions
set-option-value: Internal generic functions
Setf Expander, (setf option-value): Exported generic functions
stream-open: Internal generic functions
stream-open: Internal generic functions
stream-open: Internal generic functions
stream-open: Internal generic functions
swig-lispify: Internal functions

U
update-option-value: Internal functions

V
vendor: Exported generic functions
vendor: Exported generic functions

W
with-device: Exported macros
with-init: Exported macros
with-open-scanner-stream: Exported macros

Jump to:   (  
A   C   D   E   F   G   H   L   M   N   O   P   R   S   U   V   W  

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

A.3 Variables

Jump to:   *  
B   C   D   E   F   G   H   L   M   N   O   P   R   S   T   U   V  
Index Entry  Section

*
*device-list*: Internal special variables
*sane-references*: Internal special variables
*sane-version*: Internal special variables

B
buffer: Internal classes
buffer-fill: Internal classes
buffer-pointer: Internal classes
buflen: Internal classes
bytes-per-line: Exported classes

C
c-size: Exported classes
capabilities: Exported classes
Constant, sane_cap_advanced: Internal constants
Constant, sane_cap_automatic: Internal constants
Constant, sane_cap_emulated: Internal constants
Constant, sane_cap_hard_select: Internal constants
Constant, sane_cap_inactive: Internal constants
Constant, sane_cap_soft_detect: Internal constants
Constant, sane_cap_soft_select: Internal constants
Constant, sane_current_major: Internal constants
Constant, sane_current_minor: Internal constants
Constant, sane_false: Internal constants
Constant, sane_fixed_scale_shift: Internal constants
Constant, sane_info_inexact: Internal constants
Constant, sane_info_reload_options: Internal constants
Constant, sane_info_reload_params: Internal constants
Constant, sane_max_password_len: Internal constants
Constant, sane_max_username_len: Internal constants
Constant, sane_true: Internal constants
constraint: Exported classes

D
depth: Exported classes
description: Internal classes
device: Internal classes
device: Internal classes
dirty: Exported classes

E
eof: Internal classes

F
format: Exported classes

G
group-end-pos: Internal classes
group-start-pos: Internal classes
groups: Exported classes

H
handle: Exported classes

L
last-frame: Exported classes
lines: Exported classes
list: Internal classes

M
max: Internal classes
min: Internal classes
model: Exported classes

N
name: Exported classes
name: Internal classes

O
options: Exported classes
options-hash: Exported classes

P
parameters: Internal classes
pixels-per-line: Exported classes
position: Internal classes

R
refill-buffer-function: Internal classes

S
sane_cap_advanced: Internal constants
sane_cap_automatic: Internal constants
sane_cap_emulated: Internal constants
sane_cap_hard_select: Internal constants
sane_cap_inactive: Internal constants
sane_cap_soft_detect: Internal constants
sane_cap_soft_select: Internal constants
sane_current_major: Internal constants
sane_current_minor: Internal constants
sane_false: Internal constants
sane_fixed_scale_shift: Internal constants
sane_info_inexact: Internal constants
sane_info_reload_options: Internal constants
sane_info_reload_params: Internal constants
sane_max_password_len: Internal constants
sane_max_username_len: Internal constants
sane_true: Internal constants
Slot, buffer: Internal classes
Slot, buffer-fill: Internal classes
Slot, buffer-pointer: Internal classes
Slot, buflen: Internal classes
Slot, bytes-per-line: Exported classes
Slot, c-size: Exported classes
Slot, capabilities: Exported classes
Slot, constraint: Exported classes
Slot, depth: Exported classes
Slot, description: Internal classes
Slot, device: Internal classes
Slot, device: Internal classes
Slot, dirty: Exported classes
Slot, eof: Internal classes
Slot, format: Exported classes
Slot, group-end-pos: Internal classes
Slot, group-start-pos: Internal classes
Slot, groups: Exported classes
Slot, handle: Exported classes
Slot, last-frame: Exported classes
Slot, lines: Exported classes
Slot, list: Internal classes
Slot, max: Internal classes
Slot, min: Internal classes
Slot, model: Exported classes
Slot, name: Exported classes
Slot, name: Internal classes
Slot, options: Exported classes
Slot, options-hash: Exported classes
Slot, parameters: Internal classes
Slot, pixels-per-line: Exported classes
Slot, position: Internal classes
Slot, refill-buffer-function: Internal classes
Slot, step: Internal classes
Slot, title: Internal classes
Slot, type: Exported classes
Slot, type: Exported classes
Slot, unit: Exported classes
Slot, value: Exported classes
Slot, value: Exported classes
Slot, vendor: Exported classes
Special Variable, *device-list*: Internal special variables
Special Variable, *sane-references*: Internal special variables
Special Variable, *sane-version*: Internal special variables
step: Internal classes

T
title: Internal classes
type: Exported classes
type: Exported classes

U
unit: Exported classes

V
value: Exported classes
value: Exported classes
vendor: Exported classes

Jump to:   *  
B   C   D   E   F   G   H   L   M   N   O   P   R   S   T   U   V  

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

A.4 Data types

Jump to:   B   C   D   G   L   O   P   R   S   T  
Index Entry  Section

B
blockwise-binary-input-stream: Internal classes

C
Class, blockwise-binary-input-stream: Internal classes
Class, constraint: Internal classes
Class, device: Exported classes
Class, group: Internal classes
Class, list-constraint: Internal classes
Class, option: Exported classes
Class, option-value: Exported classes
Class, optionoid: Internal classes
Class, parameters: Exported classes
Class, range-constraint: Internal classes
Class, sane-blocking-stream: Internal classes
Class, sane_device-tclass: Internal classes
Class, sane_option_descriptor-tclass: Internal classes
Class, sane_parameters-tclass: Internal classes
Class, sane_range-tclass: Internal classes
Class, swig-generated-source: Internal classes
Class, trivial-constraint: Internal classes
constraint: Internal classes

D
device: Exported classes

G
group: Internal classes

L
list-constraint: Internal classes

O
option: Exported classes
option-value: Exported classes
optionoid: Internal classes

P
Package, sane: The sane package
Package, sane-asdf: The sane-asdf package
Package, sane-lowlevel: The sane-lowlevel package
parameters: Exported classes

R
range-constraint: Internal classes

S
sane: The sane system
sane: The sane package
sane-asdf: The sane-asdf package
sane-blocking-stream: Internal classes
sane-lowlevel: The sane-lowlevel package
sane_device-tclass: Internal classes
sane_option_descriptor-tclass: Internal classes
sane_parameters-tclass: Internal classes
sane_range-tclass: Internal classes
swig-generated-source: Internal classes
System, sane: The sane system

T
trivial-constraint: Internal classes

Jump to:   B   C   D   G   L   O   P   R   S   T