The cl-qrencode Reference Manual
Table of Contents
The cl-qrencode Reference Manual
This is the cl-qrencode Reference Manual, version 0.1.1,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 12:42:21 2020 GMT+0.
1 Introduction
cl-qrencode
QR code 2005 encoder in Common Lisp
Usage
There are some examples in demo.lisp. More detailed explanations are
listed below.
(in-package :cl-qrencode)
(defclass qr-symbol ()
(matrix modules))
(defun dark-module-p (matrix i j))
QR code is represented by a QR-SYMBOL
object in this package, where
MATRIX
is an MODULES * MODULES
array, and the color of each
module (dark or light) is indicated by dark-module-p
.
(use-package :cl-qrencode)
(defun encode-symbol (text &key (version 1) (level :level-m) (mode nil)))
(defun encode-symbol-bytes (bytes &key (version 1) (level :level-m) (mode nil)))
encode-symbol
encodes TEXT
into a QR-SYMBOL
object.
VERSION
may be adapted to accommodate the encoding data.
LEVEL
is the error correction level, which should be one of :level-l
,
:level-m
, :level-q
, or :level-h
.
For most of the time, MODE
should be left nil
.
(defun encode-png (text &key (fpath "qrcode.png") (version 1) (level :level-m)
(mode nil) (pixsize 9) (margin 8)))
This package also supports writing QR-SYMBOL
into png files.
PIXSIZE
is number of pixels for each QR-SYMBOL
module, MARGIN
is number of pixels for each side of the QRcode quiet zone.
Tests
Run via ASDF and test-op
, (asdf:test-system '#:cl-qrencode)
,
or manually using (cl-qrencode-test:run-all-tests)
once the
cl-qrencode-test
has been loaded.
The tests require the lisp-unit
library to be installed.
COPYING
Copyright (c) 2011-2014 jnjcc, Yste.org
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-qrencode
- Author
jnjcc at live.com
- License
GPL
- Description
QR code 2005 encoder in Common Lisp
- Version
0.1.1
- Dependency
zpng
- Source
cl-qrencode.asd (file)
- Components
-
3 Modules
Modules are listed depth-first from the system components tree.
3.1 cl-qrencode/utils
- Dependency
packages.lisp (file)
- Parent
cl-qrencode (system)
- Location
utils/
- Component
util.lisp (file)
3.2 cl-qrencode/rs-ecc
- Dependency
utils (module)
- Parent
cl-qrencode (system)
- Location
rs-ecc/
- Components
-
3.3 cl-qrencode/qrencode
- Dependency
rs-ecc (module)
- Parent
cl-qrencode (system)
- Location
qrencode/
- Components
-
3.4 cl-qrencode/image
- Dependency
qrencode (module)
- Parent
cl-qrencode (system)
- Location
image/
- Component
png.lisp (file)
4 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
4.1 Lisp
4.1.1 cl-qrencode.asd
- Location
cl-qrencode.asd
- Systems
cl-qrencode (system)
4.1.2 cl-qrencode/packages.lisp
- Parent
cl-qrencode (system)
- Location
packages.lisp
- Packages
cl-qrencode
4.1.3 cl-qrencode/utils/util.lisp
- Parent
utils (module)
- Location
utils/util.lisp
- Exported Definitions
-
- Internal Definitions
-
4.1.4 cl-qrencode/rs-ecc/galois.lisp
- Parent
rs-ecc (module)
- Location
rs-ecc/galois.lisp
- Internal Definitions
-
4.1.5 cl-qrencode/rs-ecc/bch-ecc.lisp
- Parent
rs-ecc (module)
- Location
rs-ecc/bch-ecc.lisp
- Internal Definitions
-
4.1.6 cl-qrencode/rs-ecc/rs-ecc.lisp
- Parent
rs-ecc (module)
- Location
rs-ecc/rs-ecc.lisp
- Internal Definitions
-
4.1.7 cl-qrencode/qrencode/modes.lisp
- Parent
qrencode (module)
- Location
qrencode/modes.lisp
- Internal Definitions
-
4.1.8 cl-qrencode/qrencode/qrspec.lisp
- Parent
qrencode (module)
- Location
qrencode/qrspec.lisp
- Internal Definitions
-
4.1.9 cl-qrencode/qrencode/input.lisp
- Parent
qrencode (module)
- Location
qrencode/input.lisp
- Exported Definitions
-
- Internal Definitions
-
4.1.10 cl-qrencode/qrencode/bstream.lisp
- Parent
qrencode (module)
- Location
qrencode/bstream.lisp
- Internal Definitions
-
4.1.11 cl-qrencode/qrencode/codeword.lisp
- Parent
qrencode (module)
- Location
qrencode/codeword.lisp
- Internal Definitions
-
4.1.12 cl-qrencode/qrencode/matrix.lisp
- Parent
qrencode (module)
- Location
qrencode/matrix.lisp
- Internal Definitions
-
4.1.13 cl-qrencode/qrencode/mask.lisp
- Parent
qrencode (module)
- Location
qrencode/mask.lisp
- Exported Definitions
dark-module-p (function)
- Internal Definitions
-
4.1.14 cl-qrencode/qrencode/encode.lisp
- Parent
qrencode (module)
- Location
qrencode/encode.lisp
- Exported Definitions
-
- Internal Definitions
-
4.1.15 cl-qrencode/image/png.lisp
- Parent
image (module)
- Location
image/png.lisp
- Exported Definitions
-
- Internal Definitions
-
5 Packages
Packages are listed by definition order.
5.1 cl-qrencode
- Source
packages.lisp (file)
- Nickname
qrcode
- Use List
common-lisp
- Exported Definitions
-
- Internal Definitions
-
6 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
6.1 Exported definitions
6.1.1 Functions
- Function: dark-module-p MATRIX I J
-
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: encode-png TEXT &key FPATH VERSION LEVEL MODE PIXSIZE MARGIN
-
- Package
cl-qrencode
- Source
png.lisp (file)
- Function: encode-png-bytes BYTES &key FPATH VERSION LEVEL MODE PIXSIZE MARGIN
-
- Package
cl-qrencode
- Source
png.lisp (file)
- Function: encode-png-stream TEXT STREAM &key VERSION LEVEL MODE PIXSIZE MARGIN
-
- Package
cl-qrencode
- Source
png.lisp (file)
- Function: encode-symbol TEXT &key VERSION LEVEL MODE
-
encode final qr symbol, unless you know what you are doing, leave MODE NIL
- Package
cl-qrencode
- Source
encode.lisp (file)
- Function: encode-symbol-bytes BYTES &key VERSION LEVEL MODE
-
encode final qr symbol from BYTES list
- Package
cl-qrencode
- Source
encode.lisp (file)
- Function: read-file-content FPATH
-
- Package
cl-qrencode
- Source
util.lisp (file)
- Function: sdebug &rest IDS
-
- Package
cl-qrencode
- Source
util.lisp (file)
- Function: undebug &rest IDS
-
- Package
cl-qrencode
- Source
util.lisp (file)
6.1.2 Generic functions
- Generic Function: matrix OBJECT
-
- Generic Function: (setf matrix) NEW-VALUE OBJECT
-
- Package
cl-qrencode
- Methods
- Method: matrix (QR-SYMBOL qr-symbol)
-
qr code symbol as matrix
- Source
encode.lisp (file)
- Method: matrix (QR-INPUT qr-input)
-
- Method: (setf matrix) NEW-VALUE (QR-INPUT qr-input)
-
raw QR code symbol (without masking) as matrix
- Source
input.lisp (file)
- Generic Function: modules OBJECT
-
- Package
cl-qrencode
- Methods
- Method: modules (QR-SYMBOL qr-symbol)
-
qr code symbol modules
- Source
encode.lisp (file)
6.1.3 Classes
- Class: qr-symbol ()
-
- Package
cl-qrencode
- Source
encode.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: matrix
-
qr code symbol as matrix
- Initargs
:matrix
- Readers
matrix (generic function)
- Slot: modules
-
qr code symbol modules
- Initargs
:modules
- Readers
modules (generic function)
6.2 Internal definitions
6.2.1 Special variables
- Special Variable: *align-coord-table*
-
# of Alignment Patterns, row/column coordinates of center modules.
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *char-count-indicator*
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *codeword-capacity-table*
-
Number of modules (as version increases, 4 modules added) A | Function pattern
modules B | Format and Version information modules C | Data modules (A^2-B-C) |
Data capacity codewords (bytes, including ecc codewords) | Remainder bits.
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *dbg-ids*
-
- Package
cl-qrencode
- Source
util.lisp (file)
- Special Variable: *ecc-blocks*
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *ecc-codewords-table*
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *ecc-level-indicator*
-
:level-l :level-m :level-q :level-h
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *mask-pattern-num*
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Special Variable: *mask-pattern-reference*
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
6.2.2 Macros
- Macro: with-gf-accessors ACCESSORS GF &body BODY
-
shortcuts for gf-exp & gf-log, usage:
(with-gf-accessors ((gfexp gf-exp)) *gf-instance* ...)
- Package
cl-qrencode
- Source
galois.lisp (file)
- Macro: with-gf-arithmetics ARITHS GF &body BODY
-
shortcuts for gf-add, gf-subtract, gf-multiply & gf-divide, usage:
(with-gf-arithmetics ((gf+ gf-add)) *gf-instance* ...)
- Package
cl-qrencode
- Source
galois.lisp (file)
- Macro: with-gf-shortcuts ACCESSORS ARITHS GF &body BODY
-
combined with-gf-accessors & with-gf-arithmetics, usage:
(with-gf-shortcuts ((gflog gf-log)) ((gf* gf-multiply)) *gf-instance* ...)
- Package
cl-qrencode
- Source
galois.lisp (file)
6.2.3 Functions
- Function: align-centers VERSION
-
list of all valid alignment pattern center modules under VERSION
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: alignment-patterns MATRIX VERSION
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: alnum->bstream BYTES
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: ascii->bytes TEXT
-
- Package
cl-qrencode
- Source
encode.lisp (file)
- Function: bch% MSG GEN REM
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: bch* POLY B
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: bch- LHS RHS
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: bch-xor LHS RHS
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: bstream->codewords BSTREAM
-
convert bstream into codewords, as coefficients of the terms of a polynomial
- Package
cl-qrencode
- Source
codeword.lisp (file)
- Function: bstream->decimal BSTREAM NBITS
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: bstream-placement BSTREAM MATRIX MODULES
-
2X4 module block for a regular symbol character. Regard the interleaved
codeword sequence as a single bit stream, which is placed in the two module
wide columns, alternately in the right and left modules, moving upwards or
downwards according to DIRECTION, skipping function patterns, changing DIRECTION
at the top or bottom of the symbol. The only exception is that no block should
ever overlap the vertical timing pattern.
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: bstream-trans-func MODE
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: byte->bstream BYTES
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: byte-value MODE BYTE
-
BYTE value under MODE
- Package
cl-qrencode
- Source
modes.lisp (file)
- Function: bytes->input BYTES VERSION LEVEL MODE
-
- Package
cl-qrencode
- Source
encode.lisp (file)
- Function: bytes-length BYTES MODE
-
number of data characters under MODE
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: calc-run-length MATRIX MODULES NUM &optional DIRECTION
-
list of number of adjacent modules in same color
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: char-count-bits VERSION MODE
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: choose-masking MATRIX MODULES LEVEL
-
mask and evaluate using each mask pattern, choose the best mask result
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: codeword-capacity VERSION
-
codeword: data word + ecc word
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: copy-and-mask MATRIX MODULES LEVEL MASK-IND
-
make a new matrix and mask using MASK-IND for later evaluation
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: data-words-capacity VERSION LEVEL
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: dbg ID FORMAT-STRING &rest ARGS
-
- Package
cl-qrencode
- Source
util.lisp (file)
- Function: decimal->bstream DEC NBITS
-
using NBITS bits to encode decimal DEC
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: ecc-block-nums VERSION LEVEL
-
# of ec codewords for each blk, # of blk 1, # of data words for blk 1, ...
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: ecc-words-capacity VERSION LEVEL
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: eci->bstream BYTES
-
TODO
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: encode-png-bytes-stream BYTES STREAM &key VERSION LEVEL MODE PIXSIZE MARGIN
-
- Package
cl-qrencode
- Source
png.lisp (file)
- Function: encoding-module-p MATRIX I J
-
modules belong to encoding region, excluding format & version information
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: evaluate-feature-1 RLENGTH
-
(5 + i) adjacent modules in row/column in same color. (N1 + i) points, N1 = 3
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: evaluate-feature-123 MATRIX MODULES
-
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: evaluate-feature-2 MATRIX MODULES
-
block m * n of modules in same color. N2 * (m-1) * (n-1) points, N2=3
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: evaluate-feature-3 RLENGTH
-
1:1:3:1:1 ration (dark:light:dark:light:dark) pattern in row/column,
preceded or followed by light area 4 modules wide. N3 points, N3 = 40
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: every-unit-matches BYTES USIZE NUNITS MODE
-
if every unit of USZIE bytes (at most NUNITS unit) within BYTES matches MODE
- Package
cl-qrencode
- Source
input.lisp (file)
- Function: final-digit-bits N
-
the final one or two digits are converted to 4 or 7 bits respectively
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: finder-patterns MATRIX MODULES
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: format-ecc LEVEL MASK-IND
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: format-information MATRIX MODULES LEVEL MASK-IND
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: function-patterns MATRIX VERSION
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: group->decimal VALUES NDIGITS
-
digit groups of length NDIGITS (1, 2 or 3) to decimal
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: input->symbol INPUT
-
encode qr symbol from a qr-input
- Package
cl-qrencode
- Source
encode.lisp (file)
- Function: kanji->bstream BYTES
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: kanji->decimal WORD RANGE
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: kanji-bytes-length BYTES
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: kanji-word-p WORD
-
(kanji-p, kanji-range: {0, 1})
- Package
cl-qrencode
- Source
modes.lisp (file)
- Function: level->index LEVEL
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: level-indicator LEVEL
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: make-matrix VERSION &optional INIT
-
make a raw matrix according to VERSION
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: make-modules-matrix MODULES &optional INIT
-
make a raw matrix with MODULES * MODULES elements
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: mask-condition INDICATOR
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: mask-matrix MATRIX MODULES LEVEL MASK-IND
-
do not evaluate, just go ahead and mask MATRIX using MASK-IND mask pattern
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: mask-pattern-ref IND
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: matrix-modules VERSION
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: minimum-version INIT-VERSION NBYTES LEVEL
-
minimum version that can hold NBYTES data words, or INIT-VERSION if bigger
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: mode->index MODE
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: mode-analyse-func MODE
-
put CUR-BYTE into MODE, and then look at following BYTES for new segment
- Package
cl-qrencode
- Source
input.lisp (file)
- Function: mode-indicator MODE
-
- Package
cl-qrencode
- Source
modes.lisp (file)
- Function: non-mask-module-p MATRIX I J
-
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: numeric->bstream BYTES
-
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: nunits-matches BYTES MODE
-
(number of units that matches MODE, and mode for the first unmatched unit)
- Package
cl-qrencode
- Source
input.lisp (file)
- Function: one-align-pattern MATRIX X Y
-
Paint one alignment pattern centered at (X, Y)
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: one-finder-pattern MATRIX X Y
-
Paint one finder pattern starting from upleft (X, Y)
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: pad-codewords BSTREAM VERSION LEVEL
-
add pad codewords (after adding padding-bits) to fill data codeword capacity
- Package
cl-qrencode
- Source
codeword.lisp (file)
- Function: padding-bits BSTREAM
-
add padding bits so that BSTREAM ends at a codeword boundary
- Package
cl-qrencode
- Source
codeword.lisp (file)
- Function: paint-color-bit MATRIX I J BIT
-
Paint data color for MATRIX[I, J] according to BIT of {0, 1}
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: paint-fcolor-bit MATRIX I J BIT
-
Paint function pattern color for MATRIX[I, J] according to BIT of {0, 1}
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: paint-square MATRIX X Y N &optional COLOR
-
Paint a square of size N*N starting from upleft (X, Y) in MATRIX to COLOR
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: pair->decimal VALUES NUM
-
alnum pairs of length NUM (1 or 2) to decimal
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: poly-ash POLY S
-
shift left POLY by S
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: poly-mod MSG GEN REM &optional SUB MUL
-
MSG % GEN, with REM remainders
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: poly-multiply POLY B &optional OP
-
multiply B on every element of POLY using OP
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: poly-substract LHS RHS &optional OP
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: raw-module-p MATRIX I J
-
nothing has been done to MATRIX[I, J]
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: remainder-bits VERSION
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: reserve-information MATRIX VERSION
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: reverse-module-color MATRIX I J
-
- Package
cl-qrencode
- Source
mask.lisp (file)
- Function: rs% MSG GEN REM
-
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Function: rs* POLY B
-
multiply B on every element of POLY under GF(2^8)
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Function: rs- LHS RHS
-
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Function: same-color-p COLOR1 COLOR2
-
during QR symbol evaluation, :fdark & :dark are considered to be same
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: segment->bstream SEGMENT VERSION
-
SEGMENT (:mode b0 b1 ...) to bit stream under VERSION
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: segment-bstream-length SEGMENT VERSION
-
bit stream length of SEGMENT (:mode b0 b1 ...) under VERSION
- Package
cl-qrencode
- Source
bstream.lisp (file)
- Function: select-init-mode BYTES VERSION
-
optimization of bitstream length: select initial mode
- Package
cl-qrencode
- Source
input.lisp (file)
- Function: separator MATRIX MODULES
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: set-color PNGARRAY X Y COLOR
-
- Package
cl-qrencode
- Source
png.lisp (file)
- Function: starts-kanji-p BYTES
-
(BYTES starts with kanji-p, kanji word value, kanji-range: {0, 1})
- Package
cl-qrencode
- Source
modes.lisp (file)
- Function: symbol->png SYMBOL PIXSIZE MARGIN
-
return the qr symbol written into a zpng:png object with PIXSIZE
pixels for each module, and MARGIN pixels on all four sides
- Package
cl-qrencode
- Source
png.lisp (file)
- Function: symbol-character BSTREAM MATRIX VERSION
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: take-data-in-turn BLOCKS BLK1 DATA1 BLK2 DATA2
-
taking data words from each block (might have different length) in turn
- Package
cl-qrencode
- Source
codeword.lisp (file)
- Function: take-in-turn BLKS
-
taking codewords from each block (bound by minimum length) in turn
- Package
cl-qrencode
- Source
codeword.lisp (file)
- Function: terminator BSTREAM VERSION LEVEL
-
End of message
- Package
cl-qrencode
- Source
modes.lisp (file)
- Function: timing-patterns MATRIX MODULES
-
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: valid-center-p X Y MODULES
-
The alignment center module is not in Finder Patterns.
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: version-ecc VERSION
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Function: version-information MATRIX MODULES VERSION
-
version information placement on two blocks of modules:
bottom-left 3*6 block: [modules-11, modules-9] * [0, 5]
top-right 6*3 block: [0, 5] * [modules-11, modules-9]
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Function: version-range VERSION
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Function: xor-subset-of BYTES
-
exclusive subset of first unit of BYTES.
as for unit, one byte for :numeric, :alnum; two bytes for :kanji
- Package
cl-qrencode
- Source
modes.lisp (file)
6.2.4 Generic functions
- Generic Function: analyse-alnum-mode INPUT &optional SEG
-
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: analyse-alnum-mode (INPUT qr-input) &optional SEG
-
- Generic Function: analyse-byte-mode INPUT &optional SEG
-
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: analyse-byte-mode (INPUT qr-input) &optional SEG
-
- Generic Function: analyse-kanji-mode INPUT &optional SEG
-
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: analyse-kanji-mode (INPUT qr-input) &optional SEG
-
- Generic Function: analyse-numeric-mode INPUT &optional SEG
-
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: analyse-numeric-mode (INPUT qr-input) &optional SEG
-
- Generic Function: append-cur-byte INPUT &optional SEG
-
append CUR-BYTE of BYTES into SEGMENTS
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: append-cur-byte (INPUT qr-input) &optional SEG
-
if CUR-BYTE is the last byte, return nil
- Generic Function: bch-ecc BCH MSGPOLY GENPOLY
-
do bch error correction under BCH(K+EC, K)
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Methods
- Method: bch-ecc (BCH bch-ecc) MSG GEN
-
- Generic Function: blocks OBJECT
-
- Package
cl-qrencode
- Methods
- Method: blocks (QR-INPUT qr-input)
-
list of list, of the form ((codeword ...) (codeword ...) ...)
after converting BSTREAM to codewords
- Source
input.lisp (file)
- Generic Function: bstream OBJECT
-
- Package
cl-qrencode
- Methods
- Method: bstream (QR-INPUT qr-input)
-
list of 0-1 values after encoding SEGMENTS
- Source
input.lisp (file)
- Generic Function: bytes OBJECT
-
- Package
cl-qrencode
- Methods
- Method: bytes (QR-INPUT qr-input)
-
list of bytes to be encoded
- Source
input.lisp (file)
- Generic Function: cur-byte OBJECT
-
- Generic Function: (setf cur-byte) NEW-VALUE OBJECT
-
- Package
cl-qrencode
- Methods
- Method: cur-byte (QR-INPUT qr-input)
-
- Method: (setf cur-byte) NEW-VALUE (QR-INPUT qr-input)
-
index of BYTES during data analysis
- Source
input.lisp (file)
- Generic Function: data-analysis INPUT
-
BYTES -> SEGMETS, switch bewteen modes as necessary to
achieve the most efficient conversion of data
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: data-analysis (INPUT qr-input)
-
- Generic Function: data-encoding INPUT
-
encode SEGMENTS into BSTREAM slot
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: data-encoding (INPUT qr-input)
-
- Generic Function: data-masking INPUT
-
mask MATRIX with best pattern, generate the final symbol
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: data-masking (INPUT qr-input)
-
(masked matrix, mask pattern reference)
- Generic Function: ec-coding INPUT
-
split BSTREAM into BLOCKS, do rs-ecc, and fill ECC-BLOCKS
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: ec-coding (INPUT qr-input)
-
- Generic Function: ecc-blocks OBJECT
-
- Package
cl-qrencode
- Methods
- Method: ecc-blocks (QR-INPUT qr-input)
-
list of list, ec codewords corresponding to BLOCKS
- Source
input.lisp (file)
- Generic Function: ecc-poly RS MSG
-
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Methods
- Method: ecc-poly (RS rs-ecc) MSG-POLY
-
Error Correction codewords Polynomial for MSG-POLY
- Generic Function: gen-poly RS
-
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Methods
- Method: gen-poly (RS rs-ecc)
-
Generator Polynomial: (x-a^0) * (x-a^1) * ... * (x-a^(ec-1))
- Generic Function: gen-poly-gflog RS
-
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Methods
- Method: gen-poly-gflog (RS rs-ecc)
-
- Generic Function: gf-add GF A B
-
- Package
cl-qrencode
- Source
galois.lisp (file)
- Methods
- Method: gf-add (GF galois) A B
-
- Generic Function: gf-divide GF A B
-
- Package
cl-qrencode
- Source
galois.lisp (file)
- Methods
- Method: gf-divide (GF galois) A B
-
- Generic Function: gf-exp GF POW
-
2^POW under Galois Field GF
- Package
cl-qrencode
- Source
galois.lisp (file)
- Methods
- Method: gf-exp (GF galois) POW
-
- Generic Function: gf-log GF VALUE
-
VALUE should be within range [0, 2^POW - 1]
- Package
cl-qrencode
- Source
galois.lisp (file)
- Methods
- Method: gf-log (GF galois) VALUE
-
- Generic Function: gf-multiply GF A B
-
- Package
cl-qrencode
- Source
galois.lisp (file)
- Methods
- Method: gf-multiply (GF galois) A B
-
- Generic Function: gf-order OBJECT
-
- Package
cl-qrencode
- Methods
- Method: gf-order (GALOIS galois)
-
automatically generated reader method
- Source
galois.lisp (file)
- Generic Function: gf-power OBJECT
-
- Package
cl-qrencode
- Methods
- Method: gf-power (GALOIS galois)
-
Galois Field GF(2^POWER)
- Source
galois.lisp (file)
- Generic Function: gf-subtract GF A B
-
- Package
cl-qrencode
- Source
galois.lisp (file)
- Methods
- Method: gf-subtract (GF galois) A B
-
- Generic Function: gpoly OBJECT
-
- Package
cl-qrencode
- Methods
- Method: gpoly (RS-ECC rs-ecc)
-
with EC, we calculate generator poly immediately
- Source
rs-ecc.lisp (file)
- Generic Function: level OBJECT
-
- Package
cl-qrencode
- Methods
- Method: level (QR-INPUT qr-input)
-
automatically generated reader method
- Source
input.lisp (file)
- Generic Function: message OBJECT
-
- Package
cl-qrencode
- Methods
- Method: message (QR-INPUT qr-input)
-
list of codewords from BLOCKS & ECC-BLOCKS,
interleaving if neccessary
- Source
input.lisp (file)
- Generic Function: mode OBJECT
-
- Package
cl-qrencode
- Methods
- Method: mode (QR-INPUT qr-input)
-
if supplied, we force all BYTES to be under MODE,
therefore, unless you know exactly what you are doing, leave this NIL
- Source
input.lisp (file)
- Generic Function: module-placement INPUT
-
write MSG-CODEWORDS into the raw (without masking) MATRIX
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: module-placement (INPUT qr-input)
-
- Generic Function: prime-poly OBJECT
-
- Package
cl-qrencode
- Methods
- Method: prime-poly (GALOIS galois)
-
prime polynomial
- Source
galois.lisp (file)
- Generic Function: redo-data-analysis INPUT
-
VERSION changed, reset CUR-BYTE and redo data analysis
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: redo-data-analysis (INPUT qr-input)
-
- Generic Function: segments OBJECT
-
- Generic Function: (setf segments) NEW-VALUE OBJECT
-
- Package
cl-qrencode
- Methods
- Method: segments (QR-INPUT qr-input)
-
- Method: (setf segments) NEW-VALUE (QR-INPUT qr-input)
-
list of list, of the form ((:mode1 byte ...) (:mode2 byte ...) ...)
- Source
input.lisp (file)
- Generic Function: structure-message INPUT
-
interleaving BLOCKS and ECC-BLOCKS into MSG-CODEWORDS
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: structure-message (INPUT qr-input)
-
- Generic Function: validate-and-analysis INPUT
-
adapt VERSION according to BYTES, and fill SEGMENTS slot
- Package
cl-qrencode
- Source
input.lisp (file)
- Methods
- Method: validate-and-analysis (INPUT qr-input)
-
- Generic Function: version OBJECT
-
- Package
cl-qrencode
- Methods
- Method: version (QR-INPUT qr-input)
-
version of qr symbol, adapted according to BYTES
- Source
input.lisp (file)
6.2.5 Classes
- Class: bch-ecc ()
-
- Package
cl-qrencode
- Source
bch-ecc.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
bch-ecc (method)
- Direct slots
- Slot: k
-
# of data codewords
- Initargs
:k
- Slot: ec
-
# of error correction codewords
- Initargs
:ec
- Class: galois ()
-
- Package
cl-qrencode
- Source
galois.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: power
-
Galois Field GF(2^POWER)
- Initargs
:power
- Readers
gf-power (generic function)
- Slot: prime-poly
-
prime polynomial
- Initargs
:ppoly
- Readers
prime-poly (generic function)
- Slot: order
-
- Readers
gf-order (generic function)
- Slot: exp-table
-
- Slot: log-table
-
- Class: qr-input ()
-
- Package
cl-qrencode
- Source
input.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: bytes
-
list of bytes to be encoded
- Type
list
- Initargs
:bytes
- Readers
bytes (generic function)
- Slot: version
-
version of qr symbol, adapted according to BYTES
- Initargs
:version
- Initform
1
- Readers
version (generic function)
- Slot: ec-level
-
- Type
cl-qrencode::ecc-level
- Initargs
:ec-level
- Initform
:level-m
- Readers
level (generic function)
- Slot: mode
-
if supplied, we force all BYTES to be under MODE,
therefore, unless you know exactly what you are doing, leave this NIL
- Type
(or null cl-qrencode::qr-mode)
- Initargs
:mode
- Readers
mode (generic function)
- Slot: cur-byte
-
index of BYTES during data analysis
- Initform
0
- Readers
cur-byte (generic function)
- Writers
(setf cur-byte) (generic function)
- Slot: segments
-
list of list, of the form ((:mode1 byte ...) (:mode2 byte ...) ...)
- Type
list
- Readers
segments (generic function)
- Writers
(setf segments) (generic function)
- Slot: bstream
-
list of 0-1 values after encoding SEGMENTS
- Type
list
- Readers
bstream (generic function)
- Slot: blocks
-
list of list, of the form ((codeword ...) (codeword ...) ...)
after converting BSTREAM to codewords
- Type
list
- Readers
blocks (generic function)
- Slot: ecc-blocks
-
list of list, ec codewords corresponding to BLOCKS
- Type
list
- Readers
ecc-blocks (generic function)
- Slot: msg-codewords
-
list of codewords from BLOCKS & ECC-BLOCKS,
interleaving if neccessary
- Type
list
- Readers
message (generic function)
- Slot: matrix
-
raw QR code symbol (without masking) as matrix
- Readers
matrix (generic function)
- Writers
(setf matrix) (generic function)
- Class: rs-ecc ()
-
- Package
cl-qrencode
- Source
rs-ecc.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: k
-
# of data codewords
- Initargs
:k
- Slot: ec
-
# of error correction codewords
- Initargs
:ec
- Slot: gpoly
-
with EC, we calculate generator poly immediately
- Readers
gpoly (generic function)
6.2.6 Types
- Type: ecc-level ()
-
- Package
cl-qrencode
- Source
qrspec.lisp (file)
- Type: module-color ()
-
:RAW, nothing has been done to this module; :RESERVE, format info reserve module
:FLIGHT/:FDARK, function pattern light/dark module; :LIGHT/:DARK, data modules
- Package
cl-qrencode
- Source
matrix.lisp (file)
- Type: qr-mode ()
-
- Package
cl-qrencode
- Source
modes.lisp (file)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
C | | |
| cl-qrencode.asd: | | The cl-qrencode․asd file |
| cl-qrencode/image: | | The cl-qrencode/image module |
| cl-qrencode/image/png.lisp: | | The cl-qrencode/image/png․lisp file |
| cl-qrencode/packages.lisp: | | The cl-qrencode/packages․lisp file |
| cl-qrencode/qrencode: | | The cl-qrencode/qrencode module |
| cl-qrencode/qrencode/bstream.lisp: | | The cl-qrencode/qrencode/bstream․lisp file |
| cl-qrencode/qrencode/codeword.lisp: | | The cl-qrencode/qrencode/codeword․lisp file |
| cl-qrencode/qrencode/encode.lisp: | | The cl-qrencode/qrencode/encode․lisp file |
| cl-qrencode/qrencode/input.lisp: | | The cl-qrencode/qrencode/input․lisp file |
| cl-qrencode/qrencode/mask.lisp: | | The cl-qrencode/qrencode/mask․lisp file |
| cl-qrencode/qrencode/matrix.lisp: | | The cl-qrencode/qrencode/matrix․lisp file |
| cl-qrencode/qrencode/modes.lisp: | | The cl-qrencode/qrencode/modes․lisp file |
| cl-qrencode/qrencode/qrspec.lisp: | | The cl-qrencode/qrencode/qrspec․lisp file |
| cl-qrencode/rs-ecc: | | The cl-qrencode/rs-ecc module |
| cl-qrencode/rs-ecc/bch-ecc.lisp: | | The cl-qrencode/rs-ecc/bch-ecc․lisp file |
| cl-qrencode/rs-ecc/galois.lisp: | | The cl-qrencode/rs-ecc/galois․lisp file |
| cl-qrencode/rs-ecc/rs-ecc.lisp: | | The cl-qrencode/rs-ecc/rs-ecc․lisp file |
| cl-qrencode/utils: | | The cl-qrencode/utils module |
| cl-qrencode/utils/util.lisp: | | The cl-qrencode/utils/util․lisp file |
|
F | | |
| File, Lisp, cl-qrencode.asd: | | The cl-qrencode․asd file |
| File, Lisp, cl-qrencode/image/png.lisp: | | The cl-qrencode/image/png․lisp file |
| File, Lisp, cl-qrencode/packages.lisp: | | The cl-qrencode/packages․lisp file |
| File, Lisp, cl-qrencode/qrencode/bstream.lisp: | | The cl-qrencode/qrencode/bstream․lisp file |
| File, Lisp, cl-qrencode/qrencode/codeword.lisp: | | The cl-qrencode/qrencode/codeword․lisp file |
| File, Lisp, cl-qrencode/qrencode/encode.lisp: | | The cl-qrencode/qrencode/encode․lisp file |
| File, Lisp, cl-qrencode/qrencode/input.lisp: | | The cl-qrencode/qrencode/input․lisp file |
| File, Lisp, cl-qrencode/qrencode/mask.lisp: | | The cl-qrencode/qrencode/mask․lisp file |
| File, Lisp, cl-qrencode/qrencode/matrix.lisp: | | The cl-qrencode/qrencode/matrix․lisp file |
| File, Lisp, cl-qrencode/qrencode/modes.lisp: | | The cl-qrencode/qrencode/modes․lisp file |
| File, Lisp, cl-qrencode/qrencode/qrspec.lisp: | | The cl-qrencode/qrencode/qrspec․lisp file |
| File, Lisp, cl-qrencode/rs-ecc/bch-ecc.lisp: | | The cl-qrencode/rs-ecc/bch-ecc․lisp file |
| File, Lisp, cl-qrencode/rs-ecc/galois.lisp: | | The cl-qrencode/rs-ecc/galois․lisp file |
| File, Lisp, cl-qrencode/rs-ecc/rs-ecc.lisp: | | The cl-qrencode/rs-ecc/rs-ecc․lisp file |
| File, Lisp, cl-qrencode/utils/util.lisp: | | The cl-qrencode/utils/util․lisp file |
|
L | | |
| Lisp File, cl-qrencode.asd: | | The cl-qrencode․asd file |
| Lisp File, cl-qrencode/image/png.lisp: | | The cl-qrencode/image/png․lisp file |
| Lisp File, cl-qrencode/packages.lisp: | | The cl-qrencode/packages․lisp file |
| Lisp File, cl-qrencode/qrencode/bstream.lisp: | | The cl-qrencode/qrencode/bstream․lisp file |
| Lisp File, cl-qrencode/qrencode/codeword.lisp: | | The cl-qrencode/qrencode/codeword․lisp file |
| Lisp File, cl-qrencode/qrencode/encode.lisp: | | The cl-qrencode/qrencode/encode․lisp file |
| Lisp File, cl-qrencode/qrencode/input.lisp: | | The cl-qrencode/qrencode/input․lisp file |
| Lisp File, cl-qrencode/qrencode/mask.lisp: | | The cl-qrencode/qrencode/mask․lisp file |
| Lisp File, cl-qrencode/qrencode/matrix.lisp: | | The cl-qrencode/qrencode/matrix․lisp file |
| Lisp File, cl-qrencode/qrencode/modes.lisp: | | The cl-qrencode/qrencode/modes․lisp file |
| Lisp File, cl-qrencode/qrencode/qrspec.lisp: | | The cl-qrencode/qrencode/qrspec․lisp file |
| Lisp File, cl-qrencode/rs-ecc/bch-ecc.lisp: | | The cl-qrencode/rs-ecc/bch-ecc․lisp file |
| Lisp File, cl-qrencode/rs-ecc/galois.lisp: | | The cl-qrencode/rs-ecc/galois․lisp file |
| Lisp File, cl-qrencode/rs-ecc/rs-ecc.lisp: | | The cl-qrencode/rs-ecc/rs-ecc․lisp file |
| Lisp File, cl-qrencode/utils/util.lisp: | | The cl-qrencode/utils/util․lisp file |
|
M | | |
| Module, cl-qrencode/image: | | The cl-qrencode/image module |
| Module, cl-qrencode/qrencode: | | The cl-qrencode/qrencode module |
| Module, cl-qrencode/rs-ecc: | | The cl-qrencode/rs-ecc module |
| Module, cl-qrencode/utils: | | The cl-qrencode/utils module |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf cur-byte) : | | Internal generic functions |
| (setf cur-byte) : | | Internal generic functions |
| (setf matrix) : | | Exported generic functions |
| (setf matrix) : | | Exported generic functions |
| (setf segments) : | | Internal generic functions |
| (setf segments) : | | Internal generic functions |
|
A | | |
| align-centers : | | Internal functions |
| alignment-patterns : | | Internal functions |
| alnum->bstream : | | Internal functions |
| analyse-alnum-mode : | | Internal generic functions |
| analyse-alnum-mode : | | Internal generic functions |
| analyse-byte-mode : | | Internal generic functions |
| analyse-byte-mode : | | Internal generic functions |
| analyse-kanji-mode : | | Internal generic functions |
| analyse-kanji-mode : | | Internal generic functions |
| analyse-numeric-mode : | | Internal generic functions |
| analyse-numeric-mode : | | Internal generic functions |
| append-cur-byte : | | Internal generic functions |
| append-cur-byte : | | Internal generic functions |
| ascii->bytes : | | Internal functions |
|
B | | |
| bch% : | | Internal functions |
| bch* : | | Internal functions |
| bch- : | | Internal functions |
| bch-ecc : | | Internal generic functions |
| bch-ecc : | | Internal generic functions |
| bch-xor : | | Internal functions |
| blocks : | | Internal generic functions |
| blocks : | | Internal generic functions |
| bstream : | | Internal generic functions |
| bstream : | | Internal generic functions |
| bstream->codewords : | | Internal functions |
| bstream->decimal : | | Internal functions |
| bstream-placement : | | Internal functions |
| bstream-trans-func : | | Internal functions |
| byte->bstream : | | Internal functions |
| byte-value : | | Internal functions |
| bytes : | | Internal generic functions |
| bytes : | | Internal generic functions |
| bytes->input : | | Internal functions |
| bytes-length : | | Internal functions |
|
C | | |
| calc-run-length : | | Internal functions |
| char-count-bits : | | Internal functions |
| choose-masking : | | Internal functions |
| codeword-capacity : | | Internal functions |
| copy-and-mask : | | Internal functions |
| cur-byte : | | Internal generic functions |
| cur-byte : | | Internal generic functions |
|
D | | |
| dark-module-p : | | Exported functions |
| data-analysis : | | Internal generic functions |
| data-analysis : | | Internal generic functions |
| data-encoding : | | Internal generic functions |
| data-encoding : | | Internal generic functions |
| data-masking : | | Internal generic functions |
| data-masking : | | Internal generic functions |
| data-words-capacity : | | Internal functions |
| dbg : | | Internal functions |
| decimal->bstream : | | Internal functions |
|
E | | |
| ec-coding : | | Internal generic functions |
| ec-coding : | | Internal generic functions |
| ecc-block-nums : | | Internal functions |
| ecc-blocks : | | Internal generic functions |
| ecc-blocks : | | Internal generic functions |
| ecc-poly : | | Internal generic functions |
| ecc-poly : | | Internal generic functions |
| ecc-words-capacity : | | Internal functions |
| eci->bstream : | | Internal functions |
| encode-png : | | Exported functions |
| encode-png-bytes : | | Exported functions |
| encode-png-bytes-stream : | | Internal functions |
| encode-png-stream : | | Exported functions |
| encode-symbol : | | Exported functions |
| encode-symbol-bytes : | | Exported functions |
| encoding-module-p : | | Internal functions |
| evaluate-feature-1 : | | Internal functions |
| evaluate-feature-123 : | | Internal functions |
| evaluate-feature-2 : | | Internal functions |
| evaluate-feature-3 : | | Internal functions |
| every-unit-matches : | | Internal functions |
|
F | | |
| final-digit-bits : | | Internal functions |
| finder-patterns : | | Internal functions |
| format-ecc : | | Internal functions |
| format-information : | | Internal functions |
| Function, align-centers : | | Internal functions |
| Function, alignment-patterns : | | Internal functions |
| Function, alnum->bstream : | | Internal functions |
| Function, ascii->bytes : | | Internal functions |
| Function, bch% : | | Internal functions |
| Function, bch* : | | Internal functions |
| Function, bch- : | | Internal functions |
| Function, bch-xor : | | Internal functions |
| Function, bstream->codewords : | | Internal functions |
| Function, bstream->decimal : | | Internal functions |
| Function, bstream-placement : | | Internal functions |
| Function, bstream-trans-func : | | Internal functions |
| Function, byte->bstream : | | Internal functions |
| Function, byte-value : | | Internal functions |
| Function, bytes->input : | | Internal functions |
| Function, bytes-length : | | Internal functions |
| Function, calc-run-length : | | Internal functions |
| Function, char-count-bits : | | Internal functions |
| Function, choose-masking : | | Internal functions |
| Function, codeword-capacity : | | Internal functions |
| Function, copy-and-mask : | | Internal functions |
| Function, dark-module-p : | | Exported functions |
| Function, data-words-capacity : | | Internal functions |
| Function, dbg : | | Internal functions |
| Function, decimal->bstream : | | Internal functions |
| Function, ecc-block-nums : | | Internal functions |
| Function, ecc-words-capacity : | | Internal functions |
| Function, eci->bstream : | | Internal functions |
| Function, encode-png : | | Exported functions |
| Function, encode-png-bytes : | | Exported functions |
| Function, encode-png-bytes-stream : | | Internal functions |
| Function, encode-png-stream : | | Exported functions |
| Function, encode-symbol : | | Exported functions |
| Function, encode-symbol-bytes : | | Exported functions |
| Function, encoding-module-p : | | Internal functions |
| Function, evaluate-feature-1 : | | Internal functions |
| Function, evaluate-feature-123 : | | Internal functions |
| Function, evaluate-feature-2 : | | Internal functions |
| Function, evaluate-feature-3 : | | Internal functions |
| Function, every-unit-matches : | | Internal functions |
| Function, final-digit-bits : | | Internal functions |
| Function, finder-patterns : | | Internal functions |
| Function, format-ecc : | | Internal functions |
| Function, format-information : | | Internal functions |
| Function, function-patterns : | | Internal functions |
| Function, group->decimal : | | Internal functions |
| Function, input->symbol : | | Internal functions |
| Function, kanji->bstream : | | Internal functions |
| Function, kanji->decimal : | | Internal functions |
| Function, kanji-bytes-length : | | Internal functions |
| Function, kanji-word-p : | | Internal functions |
| Function, level->index : | | Internal functions |
| Function, level-indicator : | | Internal functions |
| Function, make-matrix : | | Internal functions |
| Function, make-modules-matrix : | | Internal functions |
| Function, mask-condition : | | Internal functions |
| Function, mask-matrix : | | Internal functions |
| Function, mask-pattern-ref : | | Internal functions |
| Function, matrix-modules : | | Internal functions |
| Function, minimum-version : | | Internal functions |
| Function, mode->index : | | Internal functions |
| Function, mode-analyse-func : | | Internal functions |
| Function, mode-indicator : | | Internal functions |
| Function, non-mask-module-p : | | Internal functions |
| Function, numeric->bstream : | | Internal functions |
| Function, nunits-matches : | | Internal functions |
| Function, one-align-pattern : | | Internal functions |
| Function, one-finder-pattern : | | Internal functions |
| Function, pad-codewords : | | Internal functions |
| Function, padding-bits : | | Internal functions |
| Function, paint-color-bit : | | Internal functions |
| Function, paint-fcolor-bit : | | Internal functions |
| Function, paint-square : | | Internal functions |
| Function, pair->decimal : | | Internal functions |
| Function, poly-ash : | | Internal functions |
| Function, poly-mod : | | Internal functions |
| Function, poly-multiply : | | Internal functions |
| Function, poly-substract : | | Internal functions |
| Function, raw-module-p : | | Internal functions |
| Function, read-file-content : | | Exported functions |
| Function, remainder-bits : | | Internal functions |
| Function, reserve-information : | | Internal functions |
| Function, reverse-module-color : | | Internal functions |
| Function, rs% : | | Internal functions |
| Function, rs* : | | Internal functions |
| Function, rs- : | | Internal functions |
| Function, same-color-p : | | Internal functions |
| Function, sdebug : | | Exported functions |
| Function, segment->bstream : | | Internal functions |
| Function, segment-bstream-length : | | Internal functions |
| Function, select-init-mode : | | Internal functions |
| Function, separator : | | Internal functions |
| Function, set-color : | | Internal functions |
| Function, starts-kanji-p : | | Internal functions |
| Function, symbol->png : | | Internal functions |
| Function, symbol-character : | | Internal functions |
| Function, take-data-in-turn : | | Internal functions |
| Function, take-in-turn : | | Internal functions |
| Function, terminator : | | Internal functions |
| Function, timing-patterns : | | Internal functions |
| Function, undebug : | | Exported functions |
| Function, valid-center-p : | | Internal functions |
| Function, version-ecc : | | Internal functions |
| Function, version-information : | | Internal functions |
| Function, version-range : | | Internal functions |
| Function, xor-subset-of : | | Internal functions |
| function-patterns : | | Internal functions |
|
G | | |
| gen-poly : | | Internal generic functions |
| gen-poly : | | Internal generic functions |
| gen-poly-gflog : | | Internal generic functions |
| gen-poly-gflog : | | Internal generic functions |
| Generic Function, (setf cur-byte) : | | Internal generic functions |
| Generic Function, (setf matrix) : | | Exported generic functions |
| Generic Function, (setf segments) : | | Internal generic functions |
| Generic Function, analyse-alnum-mode : | | Internal generic functions |
| Generic Function, analyse-byte-mode : | | Internal generic functions |
| Generic Function, analyse-kanji-mode : | | Internal generic functions |
| Generic Function, analyse-numeric-mode : | | Internal generic functions |
| Generic Function, append-cur-byte : | | Internal generic functions |
| Generic Function, bch-ecc : | | Internal generic functions |
| Generic Function, blocks : | | Internal generic functions |
| Generic Function, bstream : | | Internal generic functions |
| Generic Function, bytes : | | Internal generic functions |
| Generic Function, cur-byte : | | Internal generic functions |
| Generic Function, data-analysis : | | Internal generic functions |
| Generic Function, data-encoding : | | Internal generic functions |
| Generic Function, data-masking : | | Internal generic functions |
| Generic Function, ec-coding : | | Internal generic functions |
| Generic Function, ecc-blocks : | | Internal generic functions |
| Generic Function, ecc-poly : | | Internal generic functions |
| Generic Function, gen-poly : | | Internal generic functions |
| Generic Function, gen-poly-gflog : | | Internal generic functions |
| Generic Function, gf-add : | | Internal generic functions |
| Generic Function, gf-divide : | | Internal generic functions |
| Generic Function, gf-exp : | | Internal generic functions |
| Generic Function, gf-log : | | Internal generic functions |
| Generic Function, gf-multiply : | | Internal generic functions |
| Generic Function, gf-order : | | Internal generic functions |
| Generic Function, gf-power : | | Internal generic functions |
| Generic Function, gf-subtract : | | Internal generic functions |
| Generic Function, gpoly : | | Internal generic functions |
| Generic Function, level : | | Internal generic functions |
| Generic Function, matrix : | | Exported generic functions |
| Generic Function, message : | | Internal generic functions |
| Generic Function, mode : | | Internal generic functions |
| Generic Function, module-placement : | | Internal generic functions |
| Generic Function, modules : | | Exported generic functions |
| Generic Function, prime-poly : | | Internal generic functions |
| Generic Function, redo-data-analysis : | | Internal generic functions |
| Generic Function, segments : | | Internal generic functions |
| Generic Function, structure-message : | | Internal generic functions |
| Generic Function, validate-and-analysis : | | Internal generic functions |
| Generic Function, version : | | Internal generic functions |
| gf-add : | | Internal generic functions |
| gf-add : | | Internal generic functions |
| gf-divide : | | Internal generic functions |
| gf-divide : | | Internal generic functions |
| gf-exp : | | Internal generic functions |
| gf-exp : | | Internal generic functions |
| gf-log : | | Internal generic functions |
| gf-log : | | Internal generic functions |
| gf-multiply : | | Internal generic functions |
| gf-multiply : | | Internal generic functions |
| gf-order : | | Internal generic functions |
| gf-order : | | Internal generic functions |
| gf-power : | | Internal generic functions |
| gf-power : | | Internal generic functions |
| gf-subtract : | | Internal generic functions |
| gf-subtract : | | Internal generic functions |
| gpoly : | | Internal generic functions |
| gpoly : | | Internal generic functions |
| group->decimal : | | Internal functions |
|
I | | |
| input->symbol : | | Internal functions |
|
K | | |
| kanji->bstream : | | Internal functions |
| kanji->decimal : | | Internal functions |
| kanji-bytes-length : | | Internal functions |
| kanji-word-p : | | Internal functions |
|
L | | |
| level : | | Internal generic functions |
| level : | | Internal generic functions |
| level->index : | | Internal functions |
| level-indicator : | | Internal functions |
|
M | | |
| Macro, with-gf-accessors : | | Internal macros |
| Macro, with-gf-arithmetics : | | Internal macros |
| Macro, with-gf-shortcuts : | | Internal macros |
| make-matrix : | | Internal functions |
| make-modules-matrix : | | Internal functions |
| mask-condition : | | Internal functions |
| mask-matrix : | | Internal functions |
| mask-pattern-ref : | | Internal functions |
| matrix : | | Exported generic functions |
| matrix : | | Exported generic functions |
| matrix : | | Exported generic functions |
| matrix-modules : | | Internal functions |
| message : | | Internal generic functions |
| message : | | Internal generic functions |
| Method, (setf cur-byte) : | | Internal generic functions |
| Method, (setf matrix) : | | Exported generic functions |
| Method, (setf segments) : | | Internal generic functions |
| Method, analyse-alnum-mode : | | Internal generic functions |
| Method, analyse-byte-mode : | | Internal generic functions |
| Method, analyse-kanji-mode : | | Internal generic functions |
| Method, analyse-numeric-mode : | | Internal generic functions |
| Method, append-cur-byte : | | Internal generic functions |
| Method, bch-ecc : | | Internal generic functions |
| Method, blocks : | | Internal generic functions |
| Method, bstream : | | Internal generic functions |
| Method, bytes : | | Internal generic functions |
| Method, cur-byte : | | Internal generic functions |
| Method, data-analysis : | | Internal generic functions |
| Method, data-encoding : | | Internal generic functions |
| Method, data-masking : | | Internal generic functions |
| Method, ec-coding : | | Internal generic functions |
| Method, ecc-blocks : | | Internal generic functions |
| Method, ecc-poly : | | Internal generic functions |
| Method, gen-poly : | | Internal generic functions |
| Method, gen-poly-gflog : | | Internal generic functions |
| Method, gf-add : | | Internal generic functions |
| Method, gf-divide : | | Internal generic functions |
| Method, gf-exp : | | Internal generic functions |
| Method, gf-log : | | Internal generic functions |
| Method, gf-multiply : | | Internal generic functions |
| Method, gf-order : | | Internal generic functions |
| Method, gf-power : | | Internal generic functions |
| Method, gf-subtract : | | Internal generic functions |
| Method, gpoly : | | Internal generic functions |
| Method, level : | | Internal generic functions |
| Method, matrix : | | Exported generic functions |
| Method, matrix : | | Exported generic functions |
| Method, message : | | Internal generic functions |
| Method, mode : | | Internal generic functions |
| Method, module-placement : | | Internal generic functions |
| Method, modules : | | Exported generic functions |
| Method, prime-poly : | | Internal generic functions |
| Method, redo-data-analysis : | | Internal generic functions |
| Method, segments : | | Internal generic functions |
| Method, structure-message : | | Internal generic functions |
| Method, validate-and-analysis : | | Internal generic functions |
| Method, version : | | Internal generic functions |
| minimum-version : | | Internal functions |
| mode : | | Internal generic functions |
| mode : | | Internal generic functions |
| mode->index : | | Internal functions |
| mode-analyse-func : | | Internal functions |
| mode-indicator : | | Internal functions |
| module-placement : | | Internal generic functions |
| module-placement : | | Internal generic functions |
| modules : | | Exported generic functions |
| modules : | | Exported generic functions |
|
N | | |
| non-mask-module-p : | | Internal functions |
| numeric->bstream : | | Internal functions |
| nunits-matches : | | Internal functions |
|
O | | |
| one-align-pattern : | | Internal functions |
| one-finder-pattern : | | Internal functions |
|
P | | |
| pad-codewords : | | Internal functions |
| padding-bits : | | Internal functions |
| paint-color-bit : | | Internal functions |
| paint-fcolor-bit : | | Internal functions |
| paint-square : | | Internal functions |
| pair->decimal : | | Internal functions |
| poly-ash : | | Internal functions |
| poly-mod : | | Internal functions |
| poly-multiply : | | Internal functions |
| poly-substract : | | Internal functions |
| prime-poly : | | Internal generic functions |
| prime-poly : | | Internal generic functions |
|
R | | |
| raw-module-p : | | Internal functions |
| read-file-content : | | Exported functions |
| redo-data-analysis : | | Internal generic functions |
| redo-data-analysis : | | Internal generic functions |
| remainder-bits : | | Internal functions |
| reserve-information : | | Internal functions |
| reverse-module-color : | | Internal functions |
| rs% : | | Internal functions |
| rs* : | | Internal functions |
| rs- : | | Internal functions |
|
S | | |
| same-color-p : | | Internal functions |
| sdebug : | | Exported functions |
| segment->bstream : | | Internal functions |
| segment-bstream-length : | | Internal functions |
| segments : | | Internal generic functions |
| segments : | | Internal generic functions |
| select-init-mode : | | Internal functions |
| separator : | | Internal functions |
| set-color : | | Internal functions |
| starts-kanji-p : | | Internal functions |
| structure-message : | | Internal generic functions |
| structure-message : | | Internal generic functions |
| symbol->png : | | Internal functions |
| symbol-character : | | Internal functions |
|
T | | |
| take-data-in-turn : | | Internal functions |
| take-in-turn : | | Internal functions |
| terminator : | | Internal functions |
| timing-patterns : | | Internal functions |
|
U | | |
| undebug : | | Exported functions |
|
V | | |
| valid-center-p : | | Internal functions |
| validate-and-analysis : | | Internal generic functions |
| validate-and-analysis : | | Internal generic functions |
| version : | | Internal generic functions |
| version : | | Internal generic functions |
| version-ecc : | | Internal functions |
| version-information : | | Internal functions |
| version-range : | | Internal functions |
|
W | | |
| with-gf-accessors : | | Internal macros |
| with-gf-arithmetics : | | Internal macros |
| with-gf-shortcuts : | | Internal macros |
|
X | | |
| xor-subset-of : | | Internal functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *align-coord-table* : | | Internal special variables |
| *char-count-indicator* : | | Internal special variables |
| *codeword-capacity-table* : | | Internal special variables |
| *dbg-ids* : | | Internal special variables |
| *ecc-blocks* : | | Internal special variables |
| *ecc-codewords-table* : | | Internal special variables |
| *ecc-level-indicator* : | | Internal special variables |
| *mask-pattern-num* : | | Internal special variables |
| *mask-pattern-reference* : | | Internal special variables |
|
B | | |
| blocks : | | Internal classes |
| bstream : | | Internal classes |
| bytes : | | Internal classes |
|
C | | |
| cur-byte : | | Internal classes |
|
E | | |
| ec : | | Internal classes |
| ec : | | Internal classes |
| ec-level : | | Internal classes |
| ecc-blocks : | | Internal classes |
| exp-table : | | Internal classes |
|
G | | |
| gpoly : | | Internal classes |
|
K | | |
| k : | | Internal classes |
| k : | | Internal classes |
|
L | | |
| log-table : | | Internal classes |
|
M | | |
| matrix : | | Exported classes |
| matrix : | | Internal classes |
| mode : | | Internal classes |
| modules : | | Exported classes |
| msg-codewords : | | Internal classes |
|
O | | |
| order : | | Internal classes |
|
P | | |
| power : | | Internal classes |
| prime-poly : | | Internal classes |
|
S | | |
| segments : | | Internal classes |
| Slot, blocks : | | Internal classes |
| Slot, bstream : | | Internal classes |
| Slot, bytes : | | Internal classes |
| Slot, cur-byte : | | Internal classes |
| Slot, ec : | | Internal classes |
| Slot, ec : | | Internal classes |
| Slot, ec-level : | | Internal classes |
| Slot, ecc-blocks : | | Internal classes |
| Slot, exp-table : | | Internal classes |
| Slot, gpoly : | | Internal classes |
| Slot, k : | | Internal classes |
| Slot, k : | | Internal classes |
| Slot, log-table : | | Internal classes |
| Slot, matrix : | | Exported classes |
| Slot, matrix : | | Internal classes |
| Slot, mode : | | Internal classes |
| Slot, modules : | | Exported classes |
| Slot, msg-codewords : | | Internal classes |
| Slot, order : | | Internal classes |
| Slot, power : | | Internal classes |
| Slot, prime-poly : | | Internal classes |
| Slot, segments : | | Internal classes |
| Slot, version : | | Internal classes |
| Special Variable, *align-coord-table* : | | Internal special variables |
| Special Variable, *char-count-indicator* : | | Internal special variables |
| Special Variable, *codeword-capacity-table* : | | Internal special variables |
| Special Variable, *dbg-ids* : | | Internal special variables |
| Special Variable, *ecc-blocks* : | | Internal special variables |
| Special Variable, *ecc-codewords-table* : | | Internal special variables |
| Special Variable, *ecc-level-indicator* : | | Internal special variables |
| Special Variable, *mask-pattern-num* : | | Internal special variables |
| Special Variable, *mask-pattern-reference* : | | Internal special variables |
|
V | | |
| version : | | Internal classes |
|
A.4 Data types
| Index Entry | | Section |
|
B | | |
| bch-ecc : | | Internal classes |
|
C | | |
| cl-qrencode : | | The cl-qrencode system |
| cl-qrencode : | | The cl-qrencode package |
| Class, bch-ecc : | | Internal classes |
| Class, galois : | | Internal classes |
| Class, qr-input : | | Internal classes |
| Class, qr-symbol : | | Exported classes |
| Class, rs-ecc : | | Internal classes |
|
E | | |
| ecc-level : | | Internal types |
|
G | | |
| galois : | | Internal classes |
|
M | | |
| module-color : | | Internal types |
|
P | | |
| Package, cl-qrencode : | | The cl-qrencode package |
|
Q | | |
| qr-input : | | Internal classes |
| qr-mode : | | Internal types |
| qr-symbol : | | Exported classes |
|
R | | |
| rs-ecc : | | Internal classes |
|
S | | |
| System, cl-qrencode : | | The cl-qrencode system |
|
T | | |
| Type, ecc-level : | | Internal types |
| Type, module-color : | | Internal types |
| Type, qr-mode : | | Internal types |
|