Lines Matching full:the
8 * this software and associated documentation files (the "Software"), to deal in
9 * the Software without restriction, including without limitation the rights to
11 * the Software, and to permit persons to whom the Software is furnished to do so,
12 * subject to the following conditions:
13 * - The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 * - The Software is provided "as is", without warranty of any kind, express or
16 * implied, including but not limited to the warranties of merchantability,
17 * fitness for a particular purpose and noninfringement. In no event shall the
20 * out of or in connection with the Software or the use or other dealings in the
41 * Invented by Denso Wave and described in the ISO/IEC 18004 standard.
43 * The library provides functions to create a QR Code from text or binary data.
44 * The library covers the QR Code Model 2 specification, supporting all versions (sizes)
48 * - High level: Take the payload data and call qrcodegen_encodeText() or qrcodegen_encodeBinary().
49 * - Low level: Custom-make the list of segments and call
51 …* (Note that all ways require supplying the desired error correction level and various byte buffer…
58 * The error correction level in a QR Code symbol.
63 qrcodegen_Ecc_LOW = 0, // The QR Code can tolerate about 7% erroneous codewords
64 qrcodegen_Ecc_MEDIUM, // The QR Code can tolerate about 15% erroneous codewords
65 qrcodegen_Ecc_QUARTILE, // The QR Code can tolerate about 25% erroneous codewords
66 qrcodegen_Ecc_HIGH, // The QR Code can tolerate about 30% erroneous codewords
71 * The mask pattern used in a QR Code symbol.
74 // A special value to tell the QR Code encoder to
77 // The eight actual mask patterns
103 * The mid-level way to create a segment is to take the payload data
105 * The low-level way to create a segment is to custom-make the bit buffer
107 * Even in the most favorable conditions, a QR Code can only hold 7089 characters of data.
108 * Any segment longer than this is meaningless for the purpose of generating QR Codes.
109 * Moreover, the maximum allowed bit length is 32767 because
110 * the largest QR Code (version 40) has 31329 modules.
113 // The mode indicator of this segment.
116 // The length of this segment's unencoded data. Measured in characters for
118 // Always zero or positive. Not the same as the data's bit length.
121 // The data bits of this segment, packed in bitwise big endian.
122 // Can be null if the bit length is zero.
125 // The number of valid data bits used in the buffer. Requires
127 // The character count (numChars) must agree with the mode and the bit buffer length.
135 #define qrcodegen_VERSION_MIN 1 // The minimum version number supported in the QR Code Model 2 s…
136 #define qrcodegen_VERSION_MAX 40 // The maximum version number supported in the QR Code Model 2 s…
138 // Calculates the number of bytes needed to store any QR Code up to and including the given version…
140 // can store any single QR Code from version 1 to 25 (inclusive). The result fits in an int (or int…
144 // The worst-case number of bytes needed to store one QR Code, up to and including
154 * Encodes the given text string to a QR Code, returning true if encoding succeeded.
155 * If the data is too long to fit in any version in the given range
156 * at the given ECC level, then false is returned.
157 * - The input text must be encoded in UTF-8 and contain no NULs.
158 * - The variables ecl and mask must correspond to enum constant values.
160 * - The arrays tempBuffer and qrcode must each have a length
162 * - After the function returns, tempBuffer contains no useful data.
163 * - If successful, the resulting QR Code may use numeric,
164 * alphanumeric, or byte mode to encode the text.
165 * - In the most optimistic case, a QR Code at version 40 with low ECC
168 * These numbers represent the hard upper limit of the QR Code standard.
169 * - Please consult the QR Code specification for information on
177 * Encodes the given binary data to a QR Code, returning true if encoding succeeded.
178 * If the data is too long to fit in any version in the given range
179 * at the given ECC level, then false is returned.
180 * - The input array range dataAndTemp[0 : dataLen] should normally be
181 * valid UTF-8 text, but is not required by the QR Code standard.
182 * - The variables ecl and mask must correspond to enum constant values.
184 * - The arrays dataAndTemp and qrcode must each have a length
186 * - After the function returns, the contents of dataAndTemp may have changed,
188 * - If successful, the resulting QR Code will use byte mode to encode the data.
189 * - In the most optimistic case, a QR Code at version 40 with low ECC can hold any byte
190 * sequence up to length 2953. This is the hard upper limit of the QR Code standard.
191 * - Please consult the QR Code specification for information on
201 * Renders a QR Code representing the given segments at the given error correction level.
202 * The smallest possible QR Code version is automatically chosen for the output. Returns true if
203 * QR Code creation succeeded, or false if the data is too long to fit in any version. The ECC level
204 …* of the result may be higher than the ecl argument if it can be done without increasing the versi…
205 * This function allows the user to create a custom sequence of segments that switches
207 …* This is a low-level API; the high-level API is qrcodegen_encodeText() and qrcodegen_encodeBinary…
208 * To save memory, the segments' data buffers can alias/overlap tempBuffer, and will
209 * result in them being clobbered, but the QR Code output will still be correct.
210 * But the qrcode array must not overlap tempBuffer or any segment's data buffer.
217 * Renders a QR Code representing the given segments with the given encoding parameters.
218 …* Returns true if QR Code creation succeeded, or false if the data is too long to fit in the range…
219 * The smallest possible QR Code version within the given range is automatically
220 * chosen for the output. Iff boostEcl is true, then the ECC level of the result
221 * may be higher than the ecl argument if it can be done without increasing the
222 * version. The mask number is either between 0 to 7 (inclusive) to force that
224 * This function allows the user to create a custom sequence of segments that switches
226 …* This is a low-level API; the high-level API is qrcodegen_encodeText() and qrcodegen_encodeBinary…
227 * To save memory, the segments' data buffers can alias/overlap tempBuffer, and will
228 * result in them being clobbered, but the QR Code output will still be correct.
229 * But the qrcode array must not overlap tempBuffer or any segment's data buffer.
236 * Tests whether the given string can be encoded as a segment in alphanumeric mode.
237 * A string is encodable iff each character is in the following set: 0 to 9, A to Z
244 * Tests whether the given string can be encoded as a segment in numeric mode.
245 * A string is encodable iff each character is in the range 0 to 9.
251 * Returns the number of bytes (uint8_t) needed for the data buffer of a segment
252 * containing the given number of characters using the given mode. Notes:
254 * the number of needed bits exceeds INT16_MAX (i.e. 32767).
255 * - Otherwise, all valid results are in the range [0, ceil(INT16_MAX / 8)], i.e. at most 4096.
256 * - It is okay for the user to allocate more bytes for the buffer than needed.
257 * - For byte mode, numChars measures the number of bytes, not Unicode code points.
258 * - For ECI mode, numChars must be 0, and the worst-case number of bytes is returned.
259 * An actual ECI segment can have shorter data. For non-ECI modes, the result is exact.
265 * Returns a segment representing the given binary data encoded in
273 * Returns a segment representing the given string of decimal digits encoded in numeric mode.
279 * Returns a segment representing the given text string encoded in alphanumeric mode.
280 * The characters allowed are: 0 to 9, A to Z (uppercase only), space,
288 * (ECI) designator with the given assignment value.
296 * Returns the side length of the given QR Code, assuming that encoding succeeded.
297 * The result is in the range [21, 177]. Note that the length of the array buffer
298 * is related to the side length - every 'uint8_t qrcode[]' must have length at least
305 * Returns the color of the module (pixel) at the given coordinates, which is false
306 * for white or true for black. The top left corner has the coordinates (x=0, y=0).
307 * If the given coordinates are out of bounds, then false (white) is returned.
312 * Returns the qrcode size of the specified version. Returns -1 on failure
316 * Returns the min version of the data that can be stored. Returns -1 on failure