The cl-pslib-barcode Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 11:20:02 2018 GMT+0.


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

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 send bug report to cage at katamail dot com

* 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.


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

2 Systems

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


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

2.1 cl-pslib-barcode

Maintainer

cage <cage@katamail.com>

Author

cage <cage@katamail.com>

License

LLGPL

Description

A barcode generator for the cl-pslib library.

Version

0.0.1

Dependencies
Source

cl-pslib-barcode.asd (file)

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 cl-pslib-barcode.asd

Location

cl-pslib-barcode.asd

Systems

cl-pslib-barcode (system)


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

3.1.2 cl-pslib-barcode/package.lisp

Parent

cl-pslib-barcode (system)

Location

package.lisp

Packages

cl-pslib-barcode


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

3.1.3 cl-pslib-barcode/conditions.lisp

Dependency

package.lisp (file)

Parent

cl-pslib-barcode (system)

Location

conditions.lisp

Internal Definitions

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

3.1.4 cl-pslib-barcode/utils.lisp

Dependency

package.lisp (file)

Parent

cl-pslib-barcode (system)

Location

utils.lisp

Internal Definitions

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

3.1.5 cl-pslib-barcode/barcode.lisp

Dependency

conditions.lisp (file)

Parent

cl-pslib-barcode (system)

Location

barcode.lisp

Exported Definitions
Internal Definitions

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

3.1.6 cl-pslib-barcode/code128.lisp

Dependencies
Parent

cl-pslib-barcode (system)

Location

code128.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-pslib-barcode

Source

package.lisp (file)

Nickname

brcd

Use List
Exported Definitions
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 Generic functions

Generic Function: draw OBJECT PSDOC
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Methods
Method: draw (OBJECT code128) (DOC psdoc)
Source

code128.lisp (file)

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

cl-pslib-barcode

Methods
Method: height (BARCODE barcode)

automatically generated reader method

Source

barcode.lisp (file)

Method: (setf height) NEW-VALUE (BARCODE barcode)

automatically generated writer method

Source

barcode.lisp (file)

Generic Function: parse OBJECT CODES
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Methods
Method: parse (OBJECT code128) CODES
Source

code128.lisp (file)

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

cl-pslib-barcode

Methods
Method: width (BARCODE barcode)

automatically generated reader method

Source

barcode.lisp (file)

Method: (setf width) NEW-VALUE (BARCODE barcode)

automatically generated writer method

Source

barcode.lisp (file)


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

5.1.2 Conditions

Condition: code128-parse-error ()
Package

cl-pslib-barcode

Source

code128.lisp (file)

Direct superclasses

text-error (condition)

Condition: code128-symbol-not-found ()
Package

cl-pslib-barcode

Source

code128.lisp (file)

Direct superclasses

text-error (condition)

Direct methods
Direct slots
Slot: variant
Initargs

:variant

Readers

variant (generic function)

Slot: code-symbol
Initargs

:code-symbol

Readers

code-symbol (generic function)


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

5.1.3 Classes

Class: barcode ()
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

code128 (class)

Direct methods
  • bar-width (method)
  • bar-width (method)
  • width (method)
  • width (method)
  • height (method)
  • height (method)
Direct slots
Slot: height
Initargs

:height

Initform

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

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: width
Initform

0

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: single-bar-width
Initargs

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

Initform

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

Readers

bar-width (generic function)

Writers

(setf bar-width) (generic function)

Class: code128 ()
Package

cl-pslib-barcode

Source

code128.lisp (file)

Direct superclasses

barcode (class)

Direct methods
Direct slots
Slot: code
Initform

(quote nil)

Readers

code (generic function)

Writers

(setf code) (generic function)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +code-a+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +code-b+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +code-c+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +code128-checksum-modulo+
Package

cl-pslib-barcode

Source

code128.lisp (file)

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

cl-pslib-barcode

Source

code128.lisp (file)

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

cl-pslib-barcode

Source

code128.lisp (file)

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

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +code128-table+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +keyword-prefix+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +shift+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +start-a+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +start-b+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +start-c+
Package

cl-pslib-barcode

Source

code128.lisp (file)

Constant: +stop+
Package

cl-pslib-barcode

Source

code128.lisp (file)


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

5.2.2 Special variables

Special Variable: *bar-height*
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Special Variable: *bar-width*
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Special Variable: *current-variant*
Package

cl-pslib-barcode

Source

code128.lisp (file)


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

5.2.3 Macros

Macro: defcond TYPE
Package

cl-pslib-barcode

Source

conditions.lisp (file)

Macro: eval-to-keyword (KEYWORDS STR) &body NOT-FOUND
Package

cl-pslib-barcode

Source

code128.lisp (file)

Macro: valid-value-p TOKEN CODES
Package

cl-pslib-barcode

Source

code128.lisp (file)

Macro: with-shifted-current-variant &body BODY
Package

cl-pslib-barcode

Source

code128.lisp (file)


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

5.2.4 Functions

Function: barcode-width BARS SINGLE-W
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Function: char@ STR POS
Package

cl-pslib-barcode

Source

utils.lisp (file)

Function: code128-checksum CODES-LIST &optional CHECKSUM CT
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: code128-lexer CODES
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: draw-bar PSDOC X W H &optional COLOR
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Function: draw-bars PSDOC BARS W H
Package

cl-pslib-barcode

Source

barcode.lisp (file)

Function: find-row POS
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: is-keyword-p KEYWORD STR
Package

cl-pslib-barcode

Source

utils.lisp (file)

Function: lookup KEY &key VARIANT
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: parse-code128 TOKENS
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: parse-shift-code-type-a TOKENS
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: parse-value-type-c TOKENS
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: parse-values-type-any TOKENS
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: shift-current-variant ()
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: start-code->current-variant START-CODE
Package

cl-pslib-barcode

Source

code128.lisp (file)

Function: tokenize-all STR &optional CODES
Package

cl-pslib-barcode

Source

code128.lisp (file)


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

5.2.5 Generic functions

Generic Function: bar-width OBJECT
Generic Function: (setf bar-width) NEW-VALUE OBJECT
Package

cl-pslib-barcode

Methods
Method: bar-width (BARCODE barcode)

automatically generated reader method

Source

barcode.lisp (file)

Method: (setf bar-width) NEW-VALUE (BARCODE barcode)

automatically generated writer method

Source

barcode.lisp (file)

Generic Function: bars-list OBJECT
Package

cl-pslib-barcode

Source

code128.lisp (file)

Methods
Method: bars-list (OBJECT code128)
Generic Function: code OBJECT
Generic Function: (setf code) NEW-VALUE OBJECT
Package

cl-pslib-barcode

Methods
Method: code (CODE128 code128)

automatically generated reader method

Source

code128.lisp (file)

Method: (setf code) NEW-VALUE (CODE128 code128)

automatically generated writer method

Source

code128.lisp (file)

Generic Function: code-symbol CONDITION
Package

cl-pslib-barcode

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

code128.lisp (file)

Generic Function: quiet-zone OBJECT
Package

cl-pslib-barcode

Source

code128.lisp (file)

Methods
Method: quiet-zone (OBJECT code128)
Generic Function: text CONDITION
Package

cl-pslib-barcode

Methods
Method: text (CONDITION text-warning)
Source

conditions.lisp (file)

Method: text (CONDITION text-error)
Source

conditions.lisp (file)

Generic Function: variant CONDITION
Package

cl-pslib-barcode

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

code128.lisp (file)


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

5.2.6 Conditions

Condition: text-error ()

Error that set text

Package

cl-pslib-barcode

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

text (method)

Direct slots
Slot: text
Initargs

:text

Readers

text (generic function)

Condition: text-warning ()

Error that set text

Package

cl-pslib-barcode

Source

conditions.lisp (file)

Direct superclasses

warning (condition)

Direct methods

text (method)

Direct slots
Slot: text
Initargs

:text

Readers

text (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-pslib-barcode.asd: The cl-pslib-barcode<dot>asd file
cl-pslib-barcode/barcode.lisp: The cl-pslib-barcode/barcode<dot>lisp file
cl-pslib-barcode/code128.lisp: The cl-pslib-barcode/code128<dot>lisp file
cl-pslib-barcode/conditions.lisp: The cl-pslib-barcode/conditions<dot>lisp file
cl-pslib-barcode/package.lisp: The cl-pslib-barcode/package<dot>lisp file
cl-pslib-barcode/utils.lisp: The cl-pslib-barcode/utils<dot>lisp file

F
File, Lisp, cl-pslib-barcode.asd: The cl-pslib-barcode<dot>asd file
File, Lisp, cl-pslib-barcode/barcode.lisp: The cl-pslib-barcode/barcode<dot>lisp file
File, Lisp, cl-pslib-barcode/code128.lisp: The cl-pslib-barcode/code128<dot>lisp file
File, Lisp, cl-pslib-barcode/conditions.lisp: The cl-pslib-barcode/conditions<dot>lisp file
File, Lisp, cl-pslib-barcode/package.lisp: The cl-pslib-barcode/package<dot>lisp file
File, Lisp, cl-pslib-barcode/utils.lisp: The cl-pslib-barcode/utils<dot>lisp file

L
Lisp File, cl-pslib-barcode.asd: The cl-pslib-barcode<dot>asd file
Lisp File, cl-pslib-barcode/barcode.lisp: The cl-pslib-barcode/barcode<dot>lisp file
Lisp File, cl-pslib-barcode/code128.lisp: The cl-pslib-barcode/code128<dot>lisp file
Lisp File, cl-pslib-barcode/conditions.lisp: The cl-pslib-barcode/conditions<dot>lisp file
Lisp File, cl-pslib-barcode/package.lisp: The cl-pslib-barcode/package<dot>lisp file
Lisp File, cl-pslib-barcode/utils.lisp: The cl-pslib-barcode/utils<dot>lisp file

Jump to:   C   F   L  

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): Internal generic functions
(setf bar-width): Internal generic functions
(setf code): Internal generic functions
(setf code): Internal generic functions
(setf height): Exported generic functions
(setf height): Exported generic functions
(setf width): Exported generic functions
(setf width): Exported generic functions

B
bar-width: Internal generic functions
bar-width: Internal generic functions
barcode-width: Internal functions
bars-list: Internal generic functions
bars-list: Internal generic functions

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

D
defcond: Internal macros
draw: Exported generic functions
draw: Exported generic functions
draw-bar: Internal functions
draw-bars: Internal functions

E
eval-to-keyword: Internal macros

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

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

H
height: Exported generic functions
height: Exported generic functions

I
is-keyword-p: Internal functions

L
lookup: Internal functions

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

P
parse: Exported generic functions
parse: Exported generic functions
parse-code128: Internal functions
parse-shift-code-type-a: Internal functions
parse-value-type-c: Internal functions
parse-values-type-any: Internal functions

Q
quiet-zone: Internal generic functions
quiet-zone: Internal generic functions

S
shift-current-variant: Internal functions
start-code->current-variant: Internal functions

T
text: Internal generic functions
text: Internal generic functions
text: Internal generic functions
tokenize-all: Internal functions

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

W
width: Exported generic functions
width: Exported generic functions
with-shifted-current-variant: Internal 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*: Internal special variables
*bar-width*: Internal special variables
*current-variant*: Internal special variables

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

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

H
height: Exported classes

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

T
text: Internal conditions
text: Internal conditions

V
variant: Exported conditions

W
width: Exported classes

Jump to:   *   +  
C   H   S   T   V   W  

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

A.4 Data types

Jump to:   B   C   P   S   T  
Index Entry  Section

B
barcode: Exported classes

C
cl-pslib-barcode: The cl-pslib-barcode system
cl-pslib-barcode: The cl-pslib-barcode package
Class, barcode: Exported classes
Class, code128: Exported classes
code128: Exported classes
code128-parse-error: Exported conditions
code128-symbol-not-found: Exported conditions
Condition, code128-parse-error: Exported conditions
Condition, code128-symbol-not-found: Exported conditions
Condition, text-error: Internal conditions
Condition, text-warning: Internal conditions

P
Package, cl-pslib-barcode: The cl-pslib-barcode package

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

T
text-error: Internal conditions
text-warning: Internal conditions

Jump to:   B   C   P   S   T