The cl-pslib-barcode Reference Manual

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

The cl-pslib-barcode Reference Manual

This is the cl-pslib-barcode Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:55:52 2022 GMT+0.

Table of Contents


1 Introduction

[[http://quickdocs.org/cl-pslib-barcode/][http://quickdocs.org/badge/cl-pslib-barcode.svg]]
* Introduction

  cl-pslib-barcode is a code128 barcode generator fo cl-pslib.

* Usage

  Please see directory  "examples/" for a quick way  to understand how
  to use the library

* Issues

* BUGS

  Please file bug report on
  the [[https://notabug.org/cage/cl-pslib-barcode/issues][issue tracker]]

* License
  This library is released under Lisp Lesser General Public license (see
  COPYING.LESSER file)

  Examples are released under GPL version 3 or later

  doc/internals/code128-grammar is  © 2012, 2013, 2014,  2015 cage and
 is  licensed under  the Creative  Commons Attribution-ShareAlike  4.0
 Internationald  License.  To  view  a copy  of  this  license,  visit
 https://creativecommons.org/licenses/by-sa/4.0/

* NO WARRANTY

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.


2 Systems

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


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

2.1 cl-pslib-barcode

A barcode generator for the cl-pslib library.

Maintainer

cage <cage-dev@twistfold.it>

Author

cage <cage-dev@twistfold.it>

License

LLGPL

Version

0.0.1

Dependencies
  • alexandria (system).
  • cffi (system).
  • cl-colors2 (system).
  • cl-ppcre-unicode (system).
  • cl-pslib (system).
Source

cl-pslib-barcode.asd.

Child Components

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   [Contents][Index]

3.1.1 cl-pslib-barcode/cl-pslib-barcode.asd

Source

cl-pslib-barcode.asd.

Parent Component

cl-pslib-barcode (system).

ASDF Systems

cl-pslib-barcode.


3.1.2 cl-pslib-barcode/package.lisp

Source

cl-pslib-barcode.asd.

Parent Component

cl-pslib-barcode (system).

Packages

cl-pslib-barcode.


3.1.3 cl-pslib-barcode/conditions.lisp

Dependency

package.lisp (file).

Source

cl-pslib-barcode.asd.

Parent Component

cl-pslib-barcode (system).

Internals

3.1.4 cl-pslib-barcode/utils.lisp

Dependency

package.lisp (file).

Source

cl-pslib-barcode.asd.

Parent Component

cl-pslib-barcode (system).

Internals

3.1.5 cl-pslib-barcode/barcode.lisp

Dependency

conditions.lisp (file).

Source

cl-pslib-barcode.asd.

Parent Component

cl-pslib-barcode (system).

Public Interface
Internals

3.1.6 cl-pslib-barcode/code128.lisp

Dependencies
Source

cl-pslib-barcode.asd.

Parent Component

cl-pslib-barcode (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 cl-pslib-barcode

Source

package.lisp.

Nickname

brcd

Use List
  • cl-colors2.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Generic functions

Generic Function: draw (object psdoc)
Package

cl-pslib-barcode.

Source

barcode.lisp.

Methods
Method: draw ((object code128) (doc psdoc))
Source

code128.lisp.

Generic Reader: height (object)
Package

cl-pslib-barcode.

Methods
Reader Method: height ((barcode barcode))

automatically generated reader method

Source

barcode.lisp.

Target Slot

height.

Generic Writer: (setf height) (object)
Package

cl-pslib-barcode.

Methods
Writer Method: (setf height) ((barcode barcode))

automatically generated writer method

Source

barcode.lisp.

Target Slot

height.

Generic Function: parse (object codes)
Package

cl-pslib-barcode.

Source

barcode.lisp.

Methods
Method: parse ((object code128) codes)
Source

code128.lisp.

Generic Reader: width (object)
Package

cl-pslib-barcode.

Methods
Reader Method: width ((barcode barcode))

automatically generated reader method

Source

barcode.lisp.

Target Slot

width.

Generic Writer: (setf width) (object)
Package

cl-pslib-barcode.

Methods
Writer Method: (setf width) ((barcode barcode))

automatically generated writer method

Source

barcode.lisp.

Target Slot

width.


5.1.2 Conditions

Condition: code128-parse-error
Package

cl-pslib-barcode.

Source

code128.lisp.

Direct superclasses

text-error.

Condition: code128-symbol-not-found
Package

cl-pslib-barcode.

Source

code128.lisp.

Direct superclasses

text-error.

Direct methods
Direct slots
Slot: variant
Initargs

:variant

Readers

variant.

Writers

This slot is read-only.

Slot: code-symbol
Initargs

:code-symbol

Readers

code-symbol.

Writers

This slot is read-only.


Previous: , Up: Public Interface   [Contents][Index]

5.1.3 Classes

Class: barcode
Package

cl-pslib-barcode.

Source

barcode.lisp.

Direct subclasses

code128.

Direct methods
Direct slots
Slot: height
Initform

cl-pslib-barcode::*bar-height*

Initargs

:height

Readers

height.

Writers

(setf height).

Slot: width
Initform

0

Readers

width.

Writers

(setf width).

Slot: single-bar-width
Initform

cl-pslib-barcode::*bar-width*

Initargs

cl-pslib-barcode::single-bar-width

Readers

bar-width.

Writers

(setf bar-width).

Class: code128
Package

cl-pslib-barcode.

Source

code128.lisp.

Direct superclasses

barcode.

Direct methods
Direct slots
Slot: code
Initform

(quote nil)

Readers

code.

Writers

(setf code).


5.2 Internals


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

5.2.1 Constants

Constant: +code-a+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code-b+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code-c+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code128-checksum-modulo+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code128-code-c-valid-regexp+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code128-min-quiet-zone-abs+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code128-min-quiet-zone-rel+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +code128-table+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +keyword-prefix+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +shift+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +start-a+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +start-b+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +start-c+
Package

cl-pslib-barcode.

Source

code128.lisp.

Constant: +stop+
Package

cl-pslib-barcode.

Source

code128.lisp.


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

5.2.2 Special variables

Special Variable: *bar-height*
Package

cl-pslib-barcode.

Source

barcode.lisp.

Special Variable: *bar-width*
Package

cl-pslib-barcode.

Source

barcode.lisp.

Special Variable: *current-variant*
Package

cl-pslib-barcode.

Source

code128.lisp.


5.2.3 Macros

Macro: defcond (type)
Package

cl-pslib-barcode.

Source

conditions.lisp.

Macro: eval-to-keyword ((keywords str) &body not-found)
Package

cl-pslib-barcode.

Source

code128.lisp.

Macro: valid-value-p (token codes)
Package

cl-pslib-barcode.

Source

code128.lisp.

Macro: with-shifted-current-variant (&body body)
Package

cl-pslib-barcode.

Source

code128.lisp.


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

5.2.4 Ordinary functions

Function: barcode-width (bars single-w)
Package

cl-pslib-barcode.

Source

barcode.lisp.

Function: char@ (str pos)
Package

cl-pslib-barcode.

Source

utils.lisp.

Function: code128-checksum (codes-list &optional checksum ct)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: code128-lexer (codes)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: draw-bar (psdoc x w h &optional color)
Package

cl-pslib-barcode.

Source

barcode.lisp.

Function: draw-bars (psdoc bars w h)
Package

cl-pslib-barcode.

Source

barcode.lisp.

Function: find-row (pos)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: is-keyword-p (keyword str)
Package

cl-pslib-barcode.

Source

utils.lisp.

Function: lookup (key &key variant)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: parse-code128 (tokens)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: parse-shift-code-type-a (tokens)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: parse-value-type-c (tokens)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: parse-values-type-any (tokens)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: shift-current-variant ()
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: start-code->current-variant (start-code)
Package

cl-pslib-barcode.

Source

code128.lisp.

Function: tokenize-all (str &optional codes)
Package

cl-pslib-barcode.

Source

code128.lisp.


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

5.2.5 Generic functions

Generic Reader: bar-width (object)
Package

cl-pslib-barcode.

Methods
Reader Method: bar-width ((barcode barcode))

automatically generated reader method

Source

barcode.lisp.

Target Slot

single-bar-width.

Generic Writer: (setf bar-width) (object)
Package

cl-pslib-barcode.

Methods
Writer Method: (setf bar-width) ((barcode barcode))

automatically generated writer method

Source

barcode.lisp.

Target Slot

single-bar-width.

Generic Function: bars-list (object)
Package

cl-pslib-barcode.

Source

code128.lisp.

Methods
Method: bars-list ((object code128))
Generic Reader: code (object)
Package

cl-pslib-barcode.

Methods
Reader Method: code ((code128 code128))

automatically generated reader method

Source

code128.lisp.

Target Slot

code.

Generic Writer: (setf code) (object)
Package

cl-pslib-barcode.

Methods
Writer Method: (setf code) ((code128 code128))

automatically generated writer method

Source

code128.lisp.

Target Slot

code.

Generic Reader: code-symbol (condition)
Package

cl-pslib-barcode.

Methods
Reader Method: code-symbol ((condition code128-symbol-not-found))
Source

code128.lisp.

Target Slot

code-symbol.

Generic Function: quiet-zone (object)
Package

cl-pslib-barcode.

Source

code128.lisp.

Methods
Method: quiet-zone ((object code128))
Generic Reader: text (condition)
Package

cl-pslib-barcode.

Methods
Reader Method: text ((condition text-warning))
Source

conditions.lisp.

Target Slot

text.

Reader Method: text ((condition text-error))
Source

conditions.lisp.

Target Slot

text.

Generic Reader: variant (condition)
Package

cl-pslib-barcode.

Methods
Reader Method: variant ((condition code128-symbol-not-found))
Source

code128.lisp.

Target Slot

variant.


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

5.2.6 Conditions

Condition: text-error

Error that set text

Package

cl-pslib-barcode.

Source

conditions.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

text.

Direct slots
Slot: text
Initargs

:text

Readers

text.

Writers

This slot is read-only.

Condition: text-warning

Error that set text

Package

cl-pslib-barcode.

Source

conditions.lisp.

Direct superclasses

warning.

Direct methods

text.

Direct slots
Slot: text
Initargs

:text

Readers

text.

Writers

This slot is read-only.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   (  
B   C   D   E   F   G   H   I   L   M   P   Q   S   T   V   W  
Index Entry  Section

(
(setf bar-width): Private generic functions
(setf bar-width): Private generic functions
(setf code): Private generic functions
(setf code): Private generic functions
(setf height): Public generic functions
(setf height): Public generic functions
(setf width): Public generic functions
(setf width): Public generic functions

B
bar-width: Private generic functions
bar-width: Private generic functions
barcode-width: Private ordinary functions
bars-list: Private generic functions
bars-list: Private generic functions

C
char@: Private ordinary functions
code: Private generic functions
code: Private generic functions
code-symbol: Private generic functions
code-symbol: Private generic functions
code128-checksum: Private ordinary functions
code128-lexer: Private ordinary functions

D
defcond: Private macros
draw: Public generic functions
draw: Public generic functions
draw-bar: Private ordinary functions
draw-bars: Private ordinary functions

E
eval-to-keyword: Private macros

F
find-row: Private ordinary functions
Function, barcode-width: Private ordinary functions
Function, char@: Private ordinary functions
Function, code128-checksum: Private ordinary functions
Function, code128-lexer: Private ordinary functions
Function, draw-bar: Private ordinary functions
Function, draw-bars: Private ordinary functions
Function, find-row: Private ordinary functions
Function, is-keyword-p: Private ordinary functions
Function, lookup: Private ordinary functions
Function, parse-code128: Private ordinary functions
Function, parse-shift-code-type-a: Private ordinary functions
Function, parse-value-type-c: Private ordinary functions
Function, parse-values-type-any: Private ordinary functions
Function, shift-current-variant: Private ordinary functions
Function, start-code->current-variant: Private ordinary functions
Function, tokenize-all: Private ordinary functions

G
Generic Function, (setf bar-width): Private generic functions
Generic Function, (setf code): Private generic functions
Generic Function, (setf height): Public generic functions
Generic Function, (setf width): Public generic functions
Generic Function, bar-width: Private generic functions
Generic Function, bars-list: Private generic functions
Generic Function, code: Private generic functions
Generic Function, code-symbol: Private generic functions
Generic Function, draw: Public generic functions
Generic Function, height: Public generic functions
Generic Function, parse: Public generic functions
Generic Function, quiet-zone: Private generic functions
Generic Function, text: Private generic functions
Generic Function, variant: Private generic functions
Generic Function, width: Public generic functions

H
height: Public generic functions
height: Public generic functions

I
is-keyword-p: Private ordinary functions

L
lookup: Private ordinary functions

M
Macro, defcond: Private macros
Macro, eval-to-keyword: Private macros
Macro, valid-value-p: Private macros
Macro, with-shifted-current-variant: Private macros
Method, (setf bar-width): Private generic functions
Method, (setf code): Private generic functions
Method, (setf height): Public generic functions
Method, (setf width): Public generic functions
Method, bar-width: Private generic functions
Method, bars-list: Private generic functions
Method, code: Private generic functions
Method, code-symbol: Private generic functions
Method, draw: Public generic functions
Method, height: Public generic functions
Method, parse: Public generic functions
Method, quiet-zone: Private generic functions
Method, text: Private generic functions
Method, text: Private generic functions
Method, variant: Private generic functions
Method, width: Public generic functions

P
parse: Public generic functions
parse: Public generic functions
parse-code128: Private ordinary functions
parse-shift-code-type-a: Private ordinary functions
parse-value-type-c: Private ordinary functions
parse-values-type-any: Private ordinary functions

Q
quiet-zone: Private generic functions
quiet-zone: Private generic functions

S
shift-current-variant: Private ordinary functions
start-code->current-variant: Private ordinary functions

T
text: Private generic functions
text: Private generic functions
text: Private generic functions
tokenize-all: Private ordinary functions

V
valid-value-p: Private macros
variant: Private generic functions
variant: Private generic functions

W
width: Public generic functions
width: Public generic functions
with-shifted-current-variant: Private macros

Jump to:   (  
B   C   D   E   F   G   H   I   L   M   P   Q   S   T   V   W  

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

A.3 Variables

Jump to:   *   +  
C   H   S   T   V   W  
Index Entry  Section

*
*bar-height*: Private special variables
*bar-width*: Private special variables
*current-variant*: Private special variables

+
+code-a+: Private constants
+code-b+: Private constants
+code-c+: Private constants
+code128-checksum-modulo+: Private constants
+code128-code-c-valid-regexp+: Private constants
+code128-min-quiet-zone-abs+: Private constants
+code128-min-quiet-zone-rel+: Private constants
+code128-table+: Private constants
+keyword-prefix+: Private constants
+shift+: Private constants
+start-a+: Private constants
+start-b+: Private constants
+start-c+: Private constants
+stop+: Private constants

C
code: Public classes
code-symbol: Public conditions
Constant, +code-a+: Private constants
Constant, +code-b+: Private constants
Constant, +code-c+: Private constants
Constant, +code128-checksum-modulo+: Private constants
Constant, +code128-code-c-valid-regexp+: Private constants
Constant, +code128-min-quiet-zone-abs+: Private constants
Constant, +code128-min-quiet-zone-rel+: Private constants
Constant, +code128-table+: Private constants
Constant, +keyword-prefix+: Private constants
Constant, +shift+: Private constants
Constant, +start-a+: Private constants
Constant, +start-b+: Private constants
Constant, +start-c+: Private constants
Constant, +stop+: Private constants

H
height: Public classes

S
single-bar-width: Public classes
Slot, code: Public classes
Slot, code-symbol: Public conditions
Slot, height: Public classes
Slot, single-bar-width: Public classes
Slot, text: Private conditions
Slot, text: Private conditions
Slot, variant: Public conditions
Slot, width: Public classes
Special Variable, *bar-height*: Private special variables
Special Variable, *bar-width*: Private special variables
Special Variable, *current-variant*: Private special variables

T
text: Private conditions
text: Private conditions

V
variant: Public conditions

W
width: Public classes

Jump to:   *   +  
C   H   S   T   V   W  

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

A.4 Data types

Jump to:   B   C   F   P   S   T   U  
Index Entry  Section

B
barcode: Public classes
barcode.lisp: The cl-pslib-barcode/barcode․lisp file

C
cl-pslib-barcode: The cl-pslib-barcode system
cl-pslib-barcode: The cl-pslib-barcode package
cl-pslib-barcode.asd: The cl-pslib-barcode/cl-pslib-barcode․asd file
Class, barcode: Public classes
Class, code128: Public classes
code128: Public classes
code128-parse-error: Public conditions
code128-symbol-not-found: Public conditions
code128.lisp: The cl-pslib-barcode/code128․lisp file
Condition, code128-parse-error: Public conditions
Condition, code128-symbol-not-found: Public conditions
Condition, text-error: Private conditions
Condition, text-warning: Private conditions
conditions.lisp: The cl-pslib-barcode/conditions․lisp file

F
File, barcode.lisp: The cl-pslib-barcode/barcode․lisp file
File, cl-pslib-barcode.asd: The cl-pslib-barcode/cl-pslib-barcode․asd file
File, code128.lisp: The cl-pslib-barcode/code128․lisp file
File, conditions.lisp: The cl-pslib-barcode/conditions․lisp file
File, package.lisp: The cl-pslib-barcode/package․lisp file
File, utils.lisp: The cl-pslib-barcode/utils․lisp file

P
Package, cl-pslib-barcode: The cl-pslib-barcode package
package.lisp: The cl-pslib-barcode/package․lisp file

S
System, cl-pslib-barcode: The cl-pslib-barcode system

T
text-error: Private conditions
text-warning: Private conditions

U
utils.lisp: The cl-pslib-barcode/utils․lisp file

Jump to:   B   C   F   P   S   T   U