This is the lispqr Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 05:52:19 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
lispqrQR code encoding.
MIT
1.0.0
zpng (system).
src (module).
Modules are listed depth-first from the system components tree.
lispqr/srclispqr (system).
packages.lisp (file).
utils.lisp (file).
image.lisp (file).
galois.lisp (file).
matrix.lisp (file).
encode.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
lispqr/lispqr.asdlispqr/src/packages.lisplispqr/src/utils.lisplispqr/src/image.lisplispqr/src/galois.lisplispqr/src/matrix.lisplispqr/src/encode.lisplispqr/src/utils.lispsrc (module).
binary->decimal (function).
clamp (function).
decimal->8-bit (function).
decimal->binary (function).
decimal->n-bit (function).
floor-div (function).
get-elt (function).
list-lpad (function).
list-ltrim (function).
list-rpad (function).
list-xor (function).
loop-index-value (macro).
print-2d-array (function).
print-bits (function).
sequence->list (function).
shift-array (function).
splice-list (function).
split-list (function).
string+ (function).
string-split (function).
swap (macro).
with-remainder (macro).
pad-bits (function).
lispqr/src/image.lispsrc (module).
write-qr-matrix (function).
write-qr-text (function).
lispqr/src/galois.lispsrc (module).
generate-ec-codewords (function).
+mod-const+ (constant).
+powers-of-2+ (special variable).
add (function).
alpha->polynom (function).
bytes->polynomial (function).
ec-polynom-div (function).
gen-generator (function).
generate-powers-of-2 (macro).
int->power (function).
mul (function).
mul-exponents (function).
order (function).
polynom->alpha (function).
polynom-add (function).
polynom-add-ec (function).
polynom-mul (function).
polynom-mul-scalar (function).
polynom-mul-x^n (function).
polynom-trim (function).
sub (function).
lispqr/src/matrix.lispsrc (module).
copy-matrix (function).
init-matrix (function).
loop-submatrix (macro).
make-qr-matrix (function).
mask-pattern (function).
mask-pattern-test-fn (function).
version-size (function).
*draw-debug* (special variable).
*draw-debug-path* (special variable).
+alignment-pattern+ (special variable).
+alignment-pattern-locations+ (special variable).
+ec-bits+ (special variable).
+finder-pattern+ (special variable).
add-alignment-patterns (function).
add-dark-module (function).
add-data-bits (function).
add-finder-patterns (function).
add-format-information-bits (function).
add-timing-patterns (function).
add-version-information-bits (function).
best-mask-pattern (function).
draw-debug-matrix (function).
eval-mask-penalty (function).
eval-mask-penalty-rule-1 (function).
eval-mask-penalty-rule-2 (function).
eval-mask-penalty-rule-3 (function).
eval-mask-penalty-rule-4 (function).
fill&mark-submatrix (function).
fill-submatrix (function).
generate-format-bits (function).
generate-version-bits (function).
is-fully-marked-submatrix (function).
is-marked-submatrix (function).
loop-submatrix-by-column (macro).
mark-submatrix (function).
mask-pattern-region (function).
match-submatrix (function).
matrix-size (function).
out-of-bounds (function).
reserve-format-information (function).
reserve-version-information (function).
lispqr/src/encode.lispsrc (module).
encode->image (function).
encode->matrix (function).
*encode-debug* (special variable).
+alphanumeric-table+ (special variable).
+character-count-indicator-table+ (special variable).
+ec-level->index+ (special variable).
+mode->index+ (special variable).
+mode-indicators+ (special variable).
+pad-alternators+ (special variable).
+remainder-bits-table+ (special variable).
+version-ec-characteristics+ (special variable).
alnum-pair->binary (function).
alphanumeric-bit-stream-length (function).
bit-stream-length (function).
byte-bit-stream-length (function).
character-count-indicator-bits (function).
data-codeword-blocks->ec-blocks (function).
data-codewords (reader method).
(setf data-codewords) (writer method).
data-codewords->blocks (function).
data-codewords-per-block (reader method).
(setf data-codewords-per-block) (writer method).
ec-blocks (reader method).
(setf ec-blocks) (writer method).
ec-codewords (reader method).
(setf ec-codewords) (writer method).
ec-codewords-per-block (reader method).
(setf ec-codewords-per-block) (writer method).
ec-level (reader method).
(setf ec-level) (writer method).
encodable-alphanumerically? (function).
encodable-byte-mode? (function).
encode (function).
encode-add-metadata (function).
encode-alphanumeric (function).
encode-bytes (function).
encode-character-count-indicator (function).
encode-codewords (function).
encode-mode-indicator (function).
encode-string-using-mode (function).
encode-terminator (function).
encoded-parts->codewords (function).
encoding-parameters-t (class).
get-best-encoding-mode (function).
get-characteristics-entry (function).
get-ec-codewords-per-block (function).
get-encoding-parameters (function).
get-entry-slot (function).
get-min-version (function).
get-min-version-and-ec-level (function).
get-required-data-codewords (function).
interleave-blocks (function).
make-ec-info-table (macro).
print-characteristics (function).
total-codewords (reader method).
(setf total-codewords) (writer method).
version (reader method).
(setf version) (writer method).
version-ec-level-characteristics (class).
when-debugging (macro).
with-entry (macro).
with-entry-slots (macro).
Packages are listed by definition order.
mare5x.lispqr.utilsmare5x.lispqr.imagemare5x.lispqr.matrixmare5x.lispqr.encodemare5x.lispqr.galoislispqr-asdmare5x.lispqr.utilscommon-lisp.
binary->decimal (function).
clamp (function).
decimal->8-bit (function).
decimal->binary (function).
decimal->n-bit (function).
floor-div (function).
get-elt (function).
list-lpad (function).
list-ltrim (function).
list-rpad (function).
list-xor (function).
loop-index-value (macro).
print-2d-array (function).
print-bits (function).
sequence->list (function).
shift-array (function).
splice-list (function).
split-list (function).
string+ (function).
string-split (function).
swap (macro).
with-remainder (macro).
pad-bits (function).
mare5x.lispqr.imagecommon-lisp.
mare5x.lispqr.utils.
zpng.
write-qr-matrix (function).
write-qr-text (function).
mare5x.lispqr.matrixcommon-lisp.
mare5x.lispqr.utils.
copy-matrix (function).
init-matrix (function).
loop-submatrix (macro).
make-qr-matrix (function).
mask-pattern (function).
mask-pattern-test-fn (function).
version-size (function).
*draw-debug* (special variable).
*draw-debug-path* (special variable).
+alignment-pattern+ (special variable).
+alignment-pattern-locations+ (special variable).
+ec-bits+ (special variable).
+finder-pattern+ (special variable).
add-alignment-patterns (function).
add-dark-module (function).
add-data-bits (function).
add-finder-patterns (function).
add-format-information-bits (function).
add-timing-patterns (function).
add-version-information-bits (function).
best-mask-pattern (function).
draw-debug-matrix (function).
eval-mask-penalty (function).
eval-mask-penalty-rule-1 (function).
eval-mask-penalty-rule-2 (function).
eval-mask-penalty-rule-3 (function).
eval-mask-penalty-rule-4 (function).
fill&mark-submatrix (function).
fill-submatrix (function).
generate-format-bits (function).
generate-version-bits (function).
is-fully-marked-submatrix (function).
is-marked-submatrix (function).
loop-submatrix-by-column (macro).
mark-submatrix (function).
mask-pattern-region (function).
match-submatrix (function).
matrix-size (function).
out-of-bounds (function).
reserve-format-information (function).
reserve-version-information (function).
mare5x.lispqr.encodelispqr
common-lisp.
mare5x.lispqr.galois.
mare5x.lispqr.image.
mare5x.lispqr.matrix.
mare5x.lispqr.utils.
encode->image (function).
encode->matrix (function).
*encode-debug* (special variable).
+alphanumeric-table+ (special variable).
+character-count-indicator-table+ (special variable).
+ec-level->index+ (special variable).
+mode->index+ (special variable).
+mode-indicators+ (special variable).
+pad-alternators+ (special variable).
+remainder-bits-table+ (special variable).
+version-ec-characteristics+ (special variable).
alnum-pair->binary (function).
alphanumeric-bit-stream-length (function).
bit-stream-length (function).
byte-bit-stream-length (function).
character-count-indicator-bits (function).
data-codeword-blocks->ec-blocks (function).
data-codewords (generic reader).
(setf data-codewords) (generic writer).
data-codewords->blocks (function).
data-codewords-per-block (generic reader).
(setf data-codewords-per-block) (generic writer).
ec-blocks (generic reader).
(setf ec-blocks) (generic writer).
ec-codewords (generic reader).
(setf ec-codewords) (generic writer).
ec-codewords-per-block (generic reader).
(setf ec-codewords-per-block) (generic writer).
ec-level (generic reader).
(setf ec-level) (generic writer).
encodable-alphanumerically? (function).
encodable-byte-mode? (function).
encode (function).
encode-add-metadata (function).
encode-alphanumeric (function).
encode-bytes (function).
encode-character-count-indicator (function).
encode-codewords (function).
encode-mode-indicator (function).
encode-string-using-mode (function).
encode-terminator (function).
encoded-parts->codewords (function).
encoding-parameters-t (class).
get-best-encoding-mode (function).
get-characteristics-entry (function).
get-ec-codewords-per-block (function).
get-encoding-parameters (function).
get-entry-slot (function).
get-min-version (function).
get-min-version-and-ec-level (function).
get-required-data-codewords (function).
interleave-blocks (function).
make-ec-info-table (macro).
print-characteristics (function).
total-codewords (generic reader).
(setf total-codewords) (generic writer).
version (generic reader).
(setf version) (generic writer).
version-ec-level-characteristics (class).
when-debugging (macro).
with-entry (macro).
with-entry-slots (macro).
mare5x.lispqr.galoiscommon-lisp.
generate-ec-codewords (function).
+mod-const+ (constant).
+powers-of-2+ (special variable).
add (function).
alpha->polynom (function).
bytes->polynomial (function).
ec-polynom-div (function).
gen-generator (function).
generate-powers-of-2 (macro).
int->power (function).
mul (function).
mul-exponents (function).
order (function).
polynom->alpha (function).
polynom-add (function).
polynom-add-ec (function).
polynom-mul (function).
polynom-mul-scalar (function).
polynom-mul-x^n (function).
polynom-trim (function).
sub (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Bind var to be n mod divisor.
Encode the string ’str’ and save it to ’path’ (png format).
Optionally specify the minimum version to be used ’min-version’ (1-40).
Error correction level ’ec-level’ can be one of (:L, :M, :Q, :H) as defined by the standard.
The ’encoding-mode’ must be in (:alphanumeric :8-bit-byte).
To force the use of a specific masking pattern, use ’mask-number’ (0-7).
If optional parameters are omitted, appropriate values will be automatically computed.
Encode the string ’str’ and return the encoded QR matrix (2-d array).
The QR matrix is a 2-d array of only 1s and 0s. A 1 denotes
a dark module and a 0 denotes a light module.
Optional parameters are the same as for ’encode->image’.
NOTE: the returned matrix does NOT contain the Quiet zone (blank border).
Generate error correction codewords for the given data. Returns a list of 8-bit error correction codewords.
Splits a sequence into a list of n-wide parts.
Returns the size of the QR code (in modules).
Returns 2 values: the masked matrix and the mask used.
Completes the encoding necessary to fill in the QR matrix.
Assumes the given version, error correction level and encoding mode are compatible with the given string.
Add Mode Indicator, Character count indicator and terminator to binary data. Returns a list of codewords.
Encodes the given string ’str’ using alphanumeric mode.
Encodes the given string ’str’ using Byte mode.
The character set used is: ISO/IEC 8859-1, which is very similar to Unicode.
As such encoding is very simple.
Calculate required terminator bits.
parts is a sequence that contains the mode indicator and encoded data.
Transforms a sequence of bits in
(mode-indicator, character-count-indicator, encoded-data, terminator)
to a valid concatenated sequence of 8-bit codewords and padded
until the required data codewords quota is filled.
Place sub-matrix into matrix at position.
Picks the ’best’ encoding parameters to encode the given string, prioritizing lower versions and higher error correction levels.
Returns the minimum version that fits the given string, encoded using encoding-mode and using the specified error correction level.
Returns the highest error correction level and lowest version that encodes the given string.
Returns the interleaving of data-blocks and ec-blocks as a list of bit-vectors. If necessary, remainder bits are also added to the result.
Check if all values in sub-matrix are of the given value.
Check if there are any 1s at the given sub-dimensions at position in matrix.
Mark matrix’s sub-dimensions with 1s at the given position.
(Left) pad a bit vector with 0s into a multiple of 8.
Remove excess zero coefficients.
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
version-ec-level-characteristics)) ¶automatically generated reader method
version-ec-level-characteristics)) ¶automatically generated writer method
(setf data-codewords).
data-codewords.
(setf data-codewords-per-block).
data-codewords-per-block.
(setf ec-blocks).
ec-blocks.
(setf ec-codewords).
ec-codewords.
(setf ec-codewords-per-block).
ec-codewords-per-block.
(setf ec-level).
ec-level.
(setf total-codewords).
total-codewords.
(setf version).
version.
:version
:ec-level
:total-codewords
:data-codewords
:ec-codewords
:ec-codewords-per-block
:ec-blocks
:data-codewords-per-block
| Jump to: | (
A B C D E F G I L M O P R S T V W |
|---|
| Jump to: | (
A B C D E F G I L M O P R S T V W |
|---|
| Jump to: | *
+
C D E S T V |
|---|
| Jump to: | *
+
C D E S T V |
|---|
| Jump to: | C E F G I L M P S U V |
|---|
| Jump to: | C E F G I L M P S U V |
|---|