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 Mon Apr 19 15:13:16 2021 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

• packages.lisp (file)
• utils (module)
• rs-ecc (module)
• qrencode (module)
• image (module)

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

• galois.lisp (file)
• bch-ecc.lisp (file)
• rs-ecc.lisp (file)

3.3 cl-qrencode/qrencode

Dependency

rs-ecc (module)

Parent

cl-qrencode (system)

Location

qrencode/

Components

• modes.lisp (file)
• qrspec.lisp (file)
• input.lisp (file)
• bstream.lisp (file)
• codeword.lisp (file)
• matrix.lisp (file)
• mask.lisp (file)
• encode.lisp (file)

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

• read-file-content (function)
• sdebug (function)
• undebug (function)

Internal Definitions

• *dbg-ids* (special variable)
• dbg (function)

4.1.4 cl-qrencode/rs-ecc/galois.lisp

Parent

rs-ecc (module)

Location

rs-ecc/galois.lisp

Internal Definitions

• galois (class)
• gf-add (generic function)
• gf-add (method)
• gf-divide (generic function)
• gf-divide (method)
• gf-exp (generic function)
• gf-exp (method)
• gf-log (generic function)
• gf-log (method)
• gf-multiply (generic function)
• gf-multiply (method)
• gf-order (method)
• gf-power (method)
• gf-subtract (generic function)
• gf-subtract (method)
• prime-poly (method)
• with-gf-accessors (macro)
• with-gf-arithmetics (macro)
• with-gf-shortcuts (macro)

4.1.5 cl-qrencode/rs-ecc/bch-ecc.lisp

Parent

rs-ecc (module)

Location

rs-ecc/bch-ecc.lisp

Internal Definitions

• bch% (function)
• bch* (function)
• bch- (function)
• bch-ecc (generic function)
• bch-ecc (method)
• bch-ecc (class)
• bch-xor (function)
• format-ecc (function)
• poly-ash (function)
• poly-mod (function)
• poly-multiply (function)
• poly-substract (function)
• version-ecc (function)

4.1.6 cl-qrencode/rs-ecc/rs-ecc.lisp

Parent

rs-ecc (module)

Location

rs-ecc/rs-ecc.lisp

Internal Definitions

• ecc-poly (generic function)
• ecc-poly (method)
• gen-poly (generic function)
• gen-poly (method)
• gen-poly-gflog (generic function)
• gen-poly-gflog (method)
• gpoly (method)
• rs% (function)
• rs* (function)
• rs- (function)
• rs-ecc (class)

4.1.7 cl-qrencode/qrencode/modes.lisp

Parent

qrencode (module)

Location

qrencode/modes.lisp

Internal Definitions

• byte-value (function)
• kanji-word-p (function)
• mode-indicator (function)
• qr-mode (type)
• starts-kanji-p (function)
• terminator (function)
• xor-subset-of (function)

4.1.8 cl-qrencode/qrencode/qrspec.lisp

Parent

qrencode (module)

Location

qrencode/qrspec.lisp

Internal Definitions

• *align-coord-table* (special variable)
• *char-count-indicator* (special variable)
• *codeword-capacity-table* (special variable)
• *ecc-blocks* (special variable)
• *ecc-codewords-table* (special variable)
• *ecc-level-indicator* (special variable)
• *mask-pattern-num* (special variable)
• *mask-pattern-reference* (special variable)
• align-centers (function)
• char-count-bits (function)
• codeword-capacity (function)
• data-words-capacity (function)
• ecc-block-nums (function)
• ecc-level (type)
• ecc-words-capacity (function)
• level->index (function)
• level-indicator (function)
• mask-condition (function)
• mask-pattern-ref (function)
• matrix-modules (function)
• minimum-version (function)
• mode->index (function)
• remainder-bits (function)
• valid-center-p (function)
• version-range (function)

4.1.9 cl-qrencode/qrencode/input.lisp

Parent

qrencode (module)

Location

qrencode/input.lisp

Exported Definitions

• matrix (method)
• (setf matrix) (method)

Internal Definitions

• analyse-alnum-mode (generic function)
• analyse-alnum-mode (method)
• analyse-byte-mode (generic function)
• analyse-byte-mode (method)
• analyse-kanji-mode (generic function)
• analyse-kanji-mode (method)
• analyse-numeric-mode (generic function)
• analyse-numeric-mode (method)
• append-cur-byte (generic function)
• append-cur-byte (method)
• blocks (method)
• bstream (method)
• bytes (method)
• cur-byte (method)
• (setf cur-byte) (method)
• data-analysis (generic function)
• data-analysis (method)
• data-encoding (generic function)
• data-encoding (method)
• data-masking (generic function)
• data-masking (method)
• ec-coding (generic function)
• ec-coding (method)
• ecc-blocks (method)
• every-unit-matches (function)
• level (method)
• message (method)
• mode (method)
• mode-analyse-func (function)
• module-placement (generic function)
• module-placement (method)
• nunits-matches (function)
• qr-input (class)
• redo-data-analysis (generic function)
• redo-data-analysis (method)
• segments (method)
• (setf segments) (method)
• select-init-mode (function)
• structure-message (generic function)
• structure-message (method)
• validate-and-analysis (generic function)
• validate-and-analysis (method)
• version (method)

4.1.10 cl-qrencode/qrencode/bstream.lisp

Parent

qrencode (module)

Location

qrencode/bstream.lisp

Internal Definitions

• alnum->bstream (function)
• bstream->decimal (function)
• bstream-trans-func (function)
• byte->bstream (function)
• bytes-length (function)
• decimal->bstream (function)
• eci->bstream (function)
• final-digit-bits (function)
• group->decimal (function)
• kanji->bstream (function)
• kanji->decimal (function)
• kanji-bytes-length (function)
• numeric->bstream (function)
• pair->decimal (function)
• segment->bstream (function)
• segment-bstream-length (function)

4.1.11 cl-qrencode/qrencode/codeword.lisp

Parent

qrencode (module)

Location

qrencode/codeword.lisp

Internal Definitions

• bstream->codewords (function)
• pad-codewords (function)
• padding-bits (function)
• take-data-in-turn (function)
• take-in-turn (function)

4.1.12 cl-qrencode/qrencode/matrix.lisp

Parent

qrencode (module)

Location

qrencode/matrix.lisp

Internal Definitions

• alignment-patterns (function)
• bstream-placement (function)
• finder-patterns (function)
• format-information (function)
• function-patterns (function)
• make-matrix (function)
• make-modules-matrix (function)
• module-color (type)
• one-align-pattern (function)
• one-finder-pattern (function)
• paint-color-bit (function)
• paint-fcolor-bit (function)
• paint-square (function)
• raw-module-p (function)
• reserve-information (function)
• same-color-p (function)
• separator (function)
• symbol-character (function)
• timing-patterns (function)
• version-information (function)

4.1.13 cl-qrencode/qrencode/mask.lisp

Parent

qrencode (module)

Location

qrencode/mask.lisp

Exported Definitions

dark-module-p (function)

Internal Definitions

• calc-run-length (function)
• choose-masking (function)
• copy-and-mask (function)
• encoding-module-p (function)
• evaluate-feature-1 (function)
• evaluate-feature-123 (function)
• evaluate-feature-2 (function)
• evaluate-feature-3 (function)
• mask-matrix (function)
• non-mask-module-p (function)
• reverse-module-color (function)

4.1.14 cl-qrencode/qrencode/encode.lisp

Parent

qrencode (module)

Location

qrencode/encode.lisp

Exported Definitions

• encode-symbol (function)
• encode-symbol-bytes (function)
• matrix (method)
• modules (method)
• qr-symbol (class)

Internal Definitions

• ascii->bytes (function)
• bytes->input (function)
• input->symbol (function)

4.1.15 cl-qrencode/image/png.lisp

Parent

image (module)

Location

image/png.lisp

Exported Definitions

• encode-png (function)
• encode-png-bytes (function)
• encode-png-stream (function)

Internal Definitions

• encode-png-bytes-stream (function)
• set-color (function)
• symbol->png (function)

5 Packages

Packages are listed by definition order.

5.1 cl-qrencode

Source

packages.lisp (file)

Nickname

qrcode

Use List

common-lisp

Exported Definitions

• dark-module-p (function)
• encode-png (function)
• encode-png-bytes (function)
• encode-png-stream (function)
• encode-symbol (function)
• encode-symbol-bytes (function)
• matrix (generic function)
• matrix (method)
• matrix (method)
• (setf matrix) (method)
• (setf matrix) (generic function)
• modules (generic function)
• modules (method)
• qr-symbol (class)
• read-file-content (function)
• sdebug (function)
• undebug (function)

Internal Definitions

• *align-coord-table* (special variable)
• *char-count-indicator* (special variable)
• *codeword-capacity-table* (special variable)
• *dbg-ids* (special variable)
• *ecc-blocks* (special variable)
• *ecc-codewords-table* (special variable)
• *ecc-level-indicator* (special variable)
• *mask-pattern-num* (special variable)
• *mask-pattern-reference* (special variable)
• align-centers (function)
• alignment-patterns (function)
• alnum->bstream (function)
• analyse-alnum-mode (generic function)
• analyse-alnum-mode (method)
• analyse-byte-mode (generic function)
• analyse-byte-mode (method)
• analyse-kanji-mode (generic function)
• analyse-kanji-mode (method)
• analyse-numeric-mode (generic function)
• analyse-numeric-mode (method)
• append-cur-byte (generic function)
• append-cur-byte (method)
• ascii->bytes (function)
• bch% (function)
• bch* (function)
• bch- (function)
• bch-ecc (generic function)
• bch-ecc (method)
• bch-ecc (class)
• bch-xor (function)
• blocks (generic function)
• blocks (method)
• bstream (generic function)
• bstream (method)
• bstream->codewords (function)
• bstream->decimal (function)
• bstream-placement (function)
• bstream-trans-func (function)
• byte->bstream (function)
• byte-value (function)
• bytes (generic function)
• bytes (method)
• bytes->input (function)
• bytes-length (function)
• calc-run-length (function)
• char-count-bits (function)
• choose-masking (function)
• codeword-capacity (function)
• copy-and-mask (function)
• cur-byte (generic function)
• cur-byte (method)
• (setf cur-byte) (method)
• (setf cur-byte) (generic function)
• data-analysis (generic function)
• data-analysis (method)
• data-encoding (generic function)
• data-encoding (method)
• data-masking (generic function)
• data-masking (method)
• data-words-capacity (function)
• dbg (function)
• decimal->bstream (function)
• ec-coding (generic function)
• ec-coding (method)
• ecc-block-nums (function)
• ecc-blocks (generic function)
• ecc-blocks (method)
• ecc-level (type)
• ecc-poly (generic function)
• ecc-poly (method)
• ecc-words-capacity (function)
• eci->bstream (function)
• encode-png-bytes-stream (function)
• encoding-module-p (function)
• evaluate-feature-1 (function)
• evaluate-feature-123 (function)
• evaluate-feature-2 (function)
• evaluate-feature-3 (function)
• every-unit-matches (function)
• final-digit-bits (function)
• finder-patterns (function)
• format-ecc (function)
• format-information (function)
• function-patterns (function)
• galois (class)
• gen-poly (generic function)
• gen-poly (method)
• gen-poly-gflog (generic function)
• gen-poly-gflog (method)
• gf-add (generic function)
• gf-add (method)
• gf-divide (generic function)
• gf-divide (method)
• gf-exp (generic function)
• gf-exp (method)
• gf-log (generic function)
• gf-log (method)
• gf-multiply (generic function)
• gf-multiply (method)
• gf-order (generic function)
• gf-order (method)
• gf-power (generic function)
• gf-power (method)
• gf-subtract (generic function)
• gf-subtract (method)
• gpoly (generic function)
• gpoly (method)
• group->decimal (function)
• input->symbol (function)
• kanji->bstream (function)
• kanji->decimal (function)
• kanji-bytes-length (function)
• kanji-word-p (function)
• level (generic function)
• level (method)
• level->index (function)
• level-indicator (function)
• make-matrix (function)
• make-modules-matrix (function)
• mask-condition (function)
• mask-matrix (function)
• mask-pattern-ref (function)
• matrix-modules (function)
• message (generic function)
• message (method)
• minimum-version (function)
• mode (generic function)
• mode (method)
• mode->index (function)
• mode-analyse-func (function)
• mode-indicator (function)
• module-color (type)
• module-placement (generic function)
• module-placement (method)
• non-mask-module-p (function)
• numeric->bstream (function)
• nunits-matches (function)
• one-align-pattern (function)
• one-finder-pattern (function)
• pad-codewords (function)
• padding-bits (function)
• paint-color-bit (function)
• paint-fcolor-bit (function)
• paint-square (function)
• pair->decimal (function)
• poly-ash (function)
• poly-mod (function)
• poly-multiply (function)
• poly-substract (function)
• prime-poly (generic function)
• prime-poly (method)
• qr-input (class)
• qr-mode (type)
• raw-module-p (function)
• redo-data-analysis (generic function)
• redo-data-analysis (method)
• remainder-bits (function)
• reserve-information (function)
• reverse-module-color (function)
• rs% (function)
• rs* (function)
• rs- (function)
• rs-ecc (class)
• same-color-p (function)
• segment->bstream (function)
• segment-bstream-length (function)
• segments (generic function)
• segments (method)
• (setf segments) (method)
• (setf segments) (generic function)
• select-init-mode (function)
• separator (function)
• set-color (function)
• starts-kanji-p (function)
• structure-message (generic function)
• structure-message (method)
• symbol->png (function)
• symbol-character (function)
• take-data-in-turn (function)
• take-in-turn (function)
• terminator (function)
• timing-patterns (function)
• valid-center-p (function)
• validate-and-analysis (generic function)
• validate-and-analysis (method)
• version (generic function)
• version (method)
• version-ecc (function)
• version-information (function)
• version-range (function)
• with-gf-accessors (macro)
• with-gf-arithmetics (macro)
• with-gf-shortcuts (macro)
• xor-subset-of (function)

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

• print-object (method)
• modules (method)
• matrix (method)

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

• gf-divide (method)
• gf-multiply (method)
• gf-subtract (method)
• gf-add (method)
• gf-log (method)
• gf-exp (method)
• initialize-instance (method)
• gf-order (method)
• prime-poly (method)
• gf-power (method)

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

• data-masking (method)
• module-placement (method)
• structure-message (method)
• ec-coding (method)
• data-encoding (method)
• validate-and-analysis (method)
• analyse-kanji-mode (method)
• append-cur-byte (method)
• analyse-numeric-mode (method)
• analyse-alnum-mode (method)
• analyse-byte-mode (method)
• redo-data-analysis (method)
• data-analysis (method)
• initialize-instance (method)
• matrix (method)
• matrix (method)
• message (method)
• ecc-blocks (method)
• blocks (method)
• bstream (method)
• segments (method)
• segments (method)
• cur-byte (method)
• cur-byte (method)
• mode (method)
• level (method)
• version (method)
• bytes (method)

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

• ecc-poly (method)
• gen-poly-gflog (method)
• gen-poly (method)
• initialize-instance (method)
• gpoly (method)

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

A.2 Functions