The lispqr Reference Manual

Table of Contents

The lispqr Reference Manual

This is the lispqr Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:55:29 2021 GMT+0.

1 Introduction

LispQR

QR Code encoding written in Common Lisp.

Usage

To write to PNG files, you will need to install zpng. If you load LispQR using lispqr.asd, all dependencies will get installed automatically:

(ql:quickload "lispqr")

;; Compile the files (lispqr.asd):
;; (ql:quickload "lispqr")

;; Change into the 'encode' package.
(in-package :mare5x.lispqr.encode)  ;; (in-package :lispqr)

;; Encode to a PNG image file.
(encode->image "https://github.com/mare5x" "test.png" :ec-level :H)

(string: "https://github.com/mare5x", version: 4, error correction level: high, encoding mode: byte)

Portacle

Checklist to get up and running using Portacle.

1. Install Portacle.
2. Ctrl-X, Ctrl-F <path to repo/lispqr.asd>
3. Focus the code buffer and press Ctrl-C, Ctrl-K to load the current file.
4. (ql:quickload "lispqr") in the REPL.
5. Now you are ready to tinker with LispQR.

References

Written based on QR standards "ISO/IEC 18004:2000" and "ISO/IEC 18004:2006".

Great additional resources:

• https://www.thonky.com/qr-code-tutorial/
• https://www.nayuki.io/page/creating-a-qr-code-step-by-step

2 Systems

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

2.1 lispqr

Author

<mare5x.dev@gmail.com>

License

MIT

Description

QR code encoding.

Version

1.0.0

Dependency

zpng

Source

lispqr.asd (file)

Component

src (module)

3 Modules

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

3.1 lispqr/src

Parent

lispqr (system)

Location

src/

Components

• packages.lisp (file)
• utils.lisp (file)
• image.lisp (file)
• galois.lisp (file)
• matrix.lisp (file)
• encode.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 lispqr.asd

Location

lispqr.asd

Systems

lispqr (system)

Packages

lispqr-asd

4.1.2 lispqr/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

• mare5x.lispqr.galois
• mare5x.lispqr.encode
• mare5x.lispqr.matrix
• mare5x.lispqr.image
• mare5x.lispqr.utils

4.1.3 lispqr/src/utils.lisp

Parent

src (module)

Location

src/utils.lisp

Exported Definitions

• 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)

Internal Definitions

pad-bits (function)

4.1.4 lispqr/src/image.lisp

Parent

src (module)

Location

src/image.lisp

Exported Definitions

• write-qr-matrix (function)
• write-qr-text (function)

4.1.5 lispqr/src/galois.lisp

Parent

src (module)

Location

src/galois.lisp

Exported Definitions

generate-ec-codewords (function)

Internal Definitions

• +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)

4.1.6 lispqr/src/matrix.lisp

Parent

src (module)

Location

src/matrix.lisp

Exported Definitions

• copy-matrix (function)
• init-matrix (function)
• loop-submatrix (macro)
• make-qr-matrix (function)
• mask-pattern (function)
• mask-pattern-test-fn (function)
• version-size (function)

Internal Definitions

• *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)

4.1.7 lispqr/src/encode.lisp

Parent

src (module)

Location

src/encode.lisp

Exported Definitions

• encode->image (function)
• encode->matrix (function)

Internal Definitions

• *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 (method)
• (setf data-codewords) (method)
• data-codewords->blocks (function)
• data-codewords-per-block (method)
• (setf data-codewords-per-block) (method)
• ec-blocks (method)
• (setf ec-blocks) (method)
• ec-codewords (method)
• (setf ec-codewords) (method)
• ec-codewords-per-block (method)
• (setf ec-codewords-per-block) (method)
• ec-level (method)
• (setf ec-level) (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 (method)
• (setf total-codewords) (method)
• version (method)
• (setf version) (method)
• version-ec-level-characteristics (class)
• when-debugging (macro)
• with-entry (macro)
• with-entry-slots (macro)

5 Packages

Packages are listed by definition order.

5.1 lispqr-asd

Source

lispqr.asd

Use List

• asdf/interface
• common-lisp

5.2 mare5x.lispqr.galois

Source

packages.lisp (file)

Use List

common-lisp

Used By List

mare5x.lispqr.encode

Exported Definitions

generate-ec-codewords (function)

Internal Definitions

• +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)

5.3 mare5x.lispqr.encode

Source

packages.lisp (file)

Nickname

lispqr

Use List

• mare5x.lispqr.image
• mare5x.lispqr.matrix
• mare5x.lispqr.galois
• mare5x.lispqr.utils
• common-lisp

Exported Definitions

• encode->image (function)
• encode->matrix (function)

Internal Definitions

• *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 function)
• data-codewords (method)
• (setf data-codewords) (method)
• (setf data-codewords) (generic function)
• data-codewords->blocks (function)
• data-codewords-per-block (generic function)
• data-codewords-per-block (method)
• (setf data-codewords-per-block) (method)
• (setf data-codewords-per-block) (generic function)
• ec-blocks (generic function)
• ec-blocks (method)
• (setf ec-blocks) (method)
• (setf ec-blocks) (generic function)
• ec-codewords (generic function)
• ec-codewords (method)
• (setf ec-codewords) (method)
• (setf ec-codewords) (generic function)
• ec-codewords-per-block (generic function)
• ec-codewords-per-block (method)
• (setf ec-codewords-per-block) (method)
• (setf ec-codewords-per-block) (generic function)
• ec-level (generic function)
• ec-level (method)
• (setf ec-level) (method)
• (setf ec-level) (generic function)
• 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 function)
• total-codewords (method)
• (setf total-codewords) (method)
• (setf total-codewords) (generic function)
• version (generic function)
• version (method)
• (setf version) (method)
• (setf version) (generic function)
• version-ec-level-characteristics (class)
• when-debugging (macro)
• with-entry (macro)
• with-entry-slots (macro)

5.4 mare5x.lispqr.matrix

Source

packages.lisp (file)

Use List

• mare5x.lispqr.utils
• common-lisp

Used By List

mare5x.lispqr.encode

Exported Definitions

• copy-matrix (function)
• init-matrix (function)
• loop-submatrix (macro)
• make-qr-matrix (function)
• mask-pattern (function)
• mask-pattern-test-fn (function)
• version-size (function)

Internal Definitions

• *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)

5.5 mare5x.lispqr.image

Source

packages.lisp (file)

Use List

• mare5x.lispqr.utils
• zpng
• common-lisp

Used By List

mare5x.lispqr.encode

Exported Definitions

• write-qr-matrix (function)
• write-qr-text (function)

5.6 mare5x.lispqr.utils

Source

packages.lisp (file)

Use List

common-lisp

Used By List

• mare5x.lispqr.encode
• mare5x.lispqr.matrix
• mare5x.lispqr.image

Exported Definitions

• 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)

Internal Definitions

pad-bits (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: loop-index-value (INDEX VALUE) SEQ &body LOOP-BODY

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Macro: loop-submatrix ((ROW COL) (&optional SUB-ROW SUB-COL)) (SUB-DIMENSIONS &optional POSITION) &body DO-BODY

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Macro: swap SEQ I J

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Macro: with-remainder (VAR N DIVISOR) &body BODY

Bind var to be n mod divisor.

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

6.1.2 Functions

Function: binary->decimal SEQ

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: clamp VAL LOW HIGH

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: copy-matrix MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: decimal->8-bit DECIMAL

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: decimal->binary N

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: decimal->n-bit DECIMAL N

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: encode->image STR PATH &key MIN-VERSION EC-LEVEL ENCODING-MODE MASK-NUMBER

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.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode->matrix STR &key MIN-VERSION EC-LEVEL ENCODING-MODE MASK-NUMBER

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

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: floor-div A B

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: generate-ec-codewords DATA-BYTES EC-CODEWORDS

Generate error correction codewords for the given data. Returns a list of 8-bit error correction codewords.

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: get-elt SEQ INDEX &optional DEFAULT

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: init-matrix SIZE &key INITIAL-ELEMENT

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: list-lpad LIST N VAL

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: list-ltrim LIST VAL

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: list-rpad LIST N VAL

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: list-xor LIST &rest REST

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: make-qr-matrix DATA VERSION EC-LEVEL &optional MASK-NUMBER

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: mask-pattern MATRIX TEST-FN

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: mask-pattern-test-fn MASK-NUMBER

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: print-2d-array ARRAY

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: print-bits BITS &optional TYPE

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: sequence->list SEQ

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: shift-array ARRAY K

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: splice-list SEQ &optional RTYPE

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: split-list SEQ N

Splits a sequence into a list of n-wide parts.

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: string+ &rest STRINGS

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: string-split STR &optional DELIM

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: version-size VERSION

Returns the size of the QR code (in modules).

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: write-qr-matrix FILE-PATH MATRIX &key MODULE-SIZE-PX

Package

mare5x.lispqr.image

Source

image.lisp (file)

Function: write-qr-text MATRIX &key DARK-CHAR LIGHT-CHAR DESTINATION

Package

mare5x.lispqr.image

Source

image.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: +mod-const+

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

6.2.2 Special variables

Special Variable: *draw-debug*

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Special Variable: *draw-debug-path*

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Special Variable: *encode-debug*

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +alignment-pattern+

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Special Variable: +alignment-pattern-locations+

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Special Variable: +alphanumeric-table+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +character-count-indicator-table+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +ec-bits+

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Special Variable: +ec-level->index+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +finder-pattern+

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Special Variable: +mode->index+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +mode-indicators+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +pad-alternators+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +powers-of-2+

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Special Variable: +remainder-bits-table+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Special Variable: +version-ec-characteristics+

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

6.2.3 Macros

Macro: generate-powers-of-2 &optional N

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Macro: loop-submatrix-by-column ((ROW COL) (SUB-ROW SUB-COL)) (SUB-DIMENSIONS POSITION) &body DO-BODY

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Macro: make-ec-info-table &rest ROWS

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Macro: when-debugging &body BODY

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Macro: with-entry (ENTRY (VERSION EC-LEVEL)) &body BODY

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Macro: with-entry-slots SLOTS VERSION EC-LEVEL &body BODY

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

6.2.4 Functions

Function: add &rest INTEGERS

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: add-alignment-patterns MATRIX MARKED VERSION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: add-dark-module MATRIX MARKED VERSION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: add-data-bits MATRIX MARKED DATA

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: add-finder-patterns MATRIX MARKED

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: add-format-information-bits MATRIX BITS

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: add-timing-patterns MATRIX MARKED

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: add-version-information-bits MATRIX VERSION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: alnum-pair->binary PAIR

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: alpha->polynom F

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: alphanumeric-bit-stream-length STR VERSION

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: best-mask-pattern MATRIX PROTECTED-REGION &optional FORCE-MASK-NUMBER

Returns 2 values: the masked matrix and the mask used.

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: bit-stream-length STR VERSION ENCODING-MODE

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: byte-bit-stream-length STR VERSION

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: bytes->polynomial BYTES

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: character-count-indicator-bits MODE VERSION

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: data-codeword-blocks->ec-blocks BLOCKS VERSION EC-LEVEL

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: data-codewords->blocks DATA-CODEWORDS VERSION EC-LEVEL

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: draw-debug-matrix MATRIX INFO-STR

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: ec-polynom-div F G EC-CODEWORDS

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: encodable-alphanumerically? STR

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encodable-byte-mode? STR

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode STR VERSION EC-LEVEL ENCODING-MODE

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.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-add-metadata ENCODED-DATA STR VERSION EC-LEVEL ENCODING-MODE

Add Mode Indicator, Character count indicator and terminator to binary data. Returns a list of codewords.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-alphanumeric STR

Encodes the given string ’str’ using alphanumeric mode.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-bytes STR

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.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-character-count-indicator STR VERSION ENCODING-MODE

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-codewords STR VERSION EC-LEVEL ENCODING-MODE

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-mode-indicator ENCODING-MODE

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-string-using-mode STR ENCODING-MODE

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encode-terminator PARTS VERSION EC-LEVEL

Calculate required terminator bits.
parts is a sequence that contains the mode indicator and encoded data.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: encoded-parts->codewords BITS VERSION EC-LEVEL

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.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: eval-mask-penalty MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: eval-mask-penalty-rule-1 MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: eval-mask-penalty-rule-2 MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: eval-mask-penalty-rule-3 MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: eval-mask-penalty-rule-4 MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: fill&mark-submatrix MATRIX MARKED SUB-MATRIX &optional POSITION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: fill-submatrix MATRIX SUB-MATRIX &optional POSITION

Place sub-matrix into matrix at position.

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: gen-generator N

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: generate-format-bits EC-LEVEL MASK-PATTERN

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: generate-version-bits VERSION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: get-best-encoding-mode STR

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-characteristics-entry VERSION EC-LEVEL

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-ec-codewords-per-block VERSION EC-LEVEL

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-encoding-parameters STR &key MIN-VERSION EC-LEVEL ENCODING-MODE

Picks the ’best’ encoding parameters to encode the given string, prioritizing lower versions and higher error correction levels.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-entry-slot VERSION EC-LEVEL SLOT

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-min-version STR MIN-VERSION EC-LEVEL ENCODING-MODE

Returns the minimum version that fits the given string, encoded using encoding-mode and using the specified error correction level.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-min-version-and-ec-level STR MIN-VERSION ENCODING-MODE

Returns the highest error correction level and lowest version that encodes the given string.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: get-required-data-codewords VERSION EC-LEVEL

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: int->power A

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: interleave-blocks DATA-BLOCKS EC-BLOCKS VERSION

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.

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: is-fully-marked-submatrix MATRIX SUB-DIMENSIONS POSITION &optional VALUE

Check if all values in sub-matrix are of the given value.

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: is-marked-submatrix MATRIX SUB-DIMENSIONS &optional POSITION

Check if there are any 1s at the given sub-dimensions at position in matrix.

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: mark-submatrix MATRIX SUB-DIMENSIONS &optional POSITION

Mark matrix’s sub-dimensions with 1s at the given position.

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: mask-pattern-region MATRIX PROTECTED-REGION MASK-NUMBER

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: match-submatrix MATRIX SUB-MATRIX POSITION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: matrix-size MATRIX

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: mul A B

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: mul-exponents A B

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: order F

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: out-of-bounds DIMENSIONS ROW COL

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: pad-bits BITS

(Left) pad a bit vector with 0s into a multiple of 8.

Package

mare5x.lispqr.utils

Source

utils.lisp (file)

Function: polynom->alpha F

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: polynom-add F G

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: polynom-add-ec F G

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: polynom-mul F G

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: polynom-mul-scalar F ALPHA

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: polynom-mul-x^n F N

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: polynom-trim F &optional COUNT

Remove excess zero coefficients.

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

Function: print-characteristics ENTRY

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Function: reserve-format-information MARKED

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: reserve-version-information MARKED VERSION

Package

mare5x.lispqr.matrix

Source

matrix.lisp (file)

Function: sub &rest INTEGERS

Package

mare5x.lispqr.galois

Source

galois.lisp (file)

6.2.5 Generic functions

Generic Function: data-codewords OBJECT

Generic Function: (setf data-codewords) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: data-codewords (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf data-codewords) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: data-codewords-per-block OBJECT

Generic Function: (setf data-codewords-per-block) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: data-codewords-per-block (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf data-codewords-per-block) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: ec-blocks OBJECT

Generic Function: (setf ec-blocks) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: ec-blocks (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf ec-blocks) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: ec-codewords OBJECT

Generic Function: (setf ec-codewords) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: ec-codewords (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf ec-codewords) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: ec-codewords-per-block OBJECT

Generic Function: (setf ec-codewords-per-block) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: ec-codewords-per-block (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf ec-codewords-per-block) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: ec-level OBJECT

Generic Function: (setf ec-level) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: ec-level (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf ec-level) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: total-codewords OBJECT

Generic Function: (setf total-codewords) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: total-codewords (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf total-codewords) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

Generic Function: version OBJECT

Generic Function: (setf version) NEW-VALUE OBJECT

Package

mare5x.lispqr.encode

Methods

Method: version (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated reader method

Source

encode.lisp (file)

Method: (setf version) NEW-VALUE (VERSION-EC-LEVEL-CHARACTERISTICS version-ec-level-characteristics)

automatically generated writer method

Source

encode.lisp (file)

6.2.6 Classes

Class: encoding-parameters-t ()

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: version

Initargs

:version

Slot: ec-level

Initargs

:ec-level

Slot: encoding-mode

Initargs

:encoding-mode

Class: version-ec-level-characteristics ()

Package

mare5x.lispqr.encode

Source

encode.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• data-codewords-per-block (method)
• data-codewords-per-block (method)
• ec-blocks (method)
• ec-blocks (method)
• ec-codewords-per-block (method)
• ec-codewords-per-block (method)
• ec-codewords (method)
• ec-codewords (method)
• data-codewords (method)
• data-codewords (method)
• total-codewords (method)
• total-codewords (method)
• ec-level (method)
• ec-level (method)
• version (method)
• version (method)

Direct slots

Slot: version

Initargs

:version

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: ec-level

Initargs

:ec-level

Readers

ec-level (generic function)

Writers

(setf ec-level) (generic function)

Slot: total-codewords

Initargs

:total-codewords

Readers

total-codewords (generic function)

Writers

(setf total-codewords) (generic function)

Slot: data-codewords

Initargs

:data-codewords

Readers

data-codewords (generic function)

Writers

(setf data-codewords) (generic function)

Slot: ec-codewords

Initargs

:ec-codewords

Readers

ec-codewords (generic function)

Writers

(setf ec-codewords) (generic function)

Slot: ec-codewords-per-block

Initargs

:ec-codewords-per-block

Readers

ec-codewords-per-block (generic function)

Writers

(setf ec-codewords-per-block) (generic function)

Slot: ec-blocks

Initargs

:ec-blocks

Readers

ec-blocks (generic function)

Writers

(setf ec-blocks) (generic function)

Slot: data-codewords-per-block

Initargs

:data-codewords-per-block

Readers

data-codewords-per-block (generic function)

Writers

(setf data-codewords-per-block) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions