libqrencode

https://fukuchi.org/works/qrencode/
Admin
libqrencode is a fast and compact C library for generating QR codes (2D barcodes) with automatic...
Tokens:5,476
Snippets:37
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Compile and Install with Autotools

Source: https://fukuchi.org/works/qrencode

Standard sequence of commands to configure, build, and install the library on Unix-like systems.

```bash
$ ./configure
$ make
$ sudo make install
$ sudo ldconfig
```

--------------------------------

### Create and Append to QRinput Object

Source: https://fukuchi.org/works/qrencode/manual

Demonstrates the process of creating a QRinput object and adding data to it for encoding. The QRinput object can be reused for encoding with different parameters.

```c
QRinput *input;
input = QRinput_new();
QRinput_append(input, version, level, hint, string);
```

--------------------------------

### Compile with CMake

Source: https://fukuchi.org/works/qrencode

Alternative build process using CMake if the configure script is unavailable or fails.

```bash
cmake .
make
```

--------------------------------

### QRinput API Functions

Source: https://fukuchi.org/works/qrencode/manual/globals_func.html

Functions for creating, managing, and manipulating QR input data structures.

```APIDOC
## QRinput API Functions

### Description
Provides functions for creating, managing, and manipulating QR input data structures before encoding.

### Functions

- **QRinput_new()**
  * Description: Creates a new QR input structure.
  * Returns: QRinput* - Pointer to the new QR input structure, or NULL on failure.
  * File: qrencode.h

- **QRinput_new2(QRencodeMode mode, int capacity)
  * Description: Creates a new QR input structure with specified mode and capacity.
  * Parameters:
    * mode (QRencodeMode): The encoding mode.
    * capacity (int): The initial capacity.
  * Returns: QRinput* - Pointer to the new QR input structure, or NULL on failure.
  * File: qrencode.h

- **QRinput_newMQR(int capacity)
  * Description: Creates a new Micro QR input structure.
  * Parameters:
    * capacity (int): The initial capacity.
  * Returns: QRinput* - Pointer to the new Micro QR input structure, or NULL on failure.
  * File: qrencode.h

- **QRinput_free(QRinput *input)
  * Description: Frees the memory allocated for a QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure to free.
  * File: qrencode.h

- **QRinput_append(QRinput *input, const char *string)
  * Description: Appends a string to the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * string (const char*): The string to append.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_appendECIheader(QRinput *input, int eci)
  * Description: Appends an ECI header to the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * eci (int): The ECI value.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_check(const QRinput *input, QRecLevel level)
  * Description: Checks the validity of the QR input structure for a given error correction level.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * level (QRecLevel): The error correction level.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_getErrorCorrectionLevel(const QRinput *input)
  * Description: Gets the error correction level of the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
  * Returns: QRecLevel - The error correction level.
  * File: qrencode.h

- **QRinput_getVersion(const QRinput *input)
  * Description: Gets the version of the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
  * Returns: int - The QR code version.
  * File: qrencode.h

- **QRinput_setErrorCorrectionLevel(QRinput *input, QRecLevel level)
  * Description: Sets the error correction level for the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * level (QRecLevel): The error correction level to set.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_setFNC1First(QRinput *input, int f1)
  * Description: Sets the FNC1 indicator for the first position.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * f1 (int): 1 to set FNC1, 0 otherwise.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_setFNC1Second(QRinput *input, int f1)
  * Description: Sets the FNC1 indicator for the second position.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * f1 (int): 1 to set FNC1, 0 otherwise.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_setVersion(QRinput *input, int version)
  * Description: Sets the version for the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * version (int): The QR code version to set.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_setVersionAndErrorCorrectionLevel(QRinput *input, int version, QRecLevel level)
  * Description: Sets the version and error correction level for the QR input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * version (int): The QR code version to set.
    * level (QRecLevel): The error correction level to set.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_splitQRinputToStruct(QRinput *input, QRinput_Struct **struct_input)
  * Description: Splits a QR input structure into a structured append input structure.
  * Parameters:
    * input (QRinput*): Pointer to the QR input structure.
    * struct_input (QRinput_Struct**): Pointer to store the new structured input structure.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

```

--------------------------------

### Create QRinput_Struct for Structured Append

Source: https://fukuchi.org/works/qrencode/manual

Instantiates a QRinput_Struct object to manage multiple QRinput objects for generating structured-append symbols. This object holds individual QRinputs, each resulting in one QR code.

```c
QRinput_Struct *QRinput_Struct_new();
```

--------------------------------

### Encode Structured Input Data with QRcode_encodeInput()

Source: https://fukuchi.org/works/qrencode/manual

Encodes data that has been manually constructed into a QRinput object. This method is suitable when the structure of the input data is known and needs precise control.

```c
QRcode_encodeInput(input, version, level);
```

--------------------------------

### QRinput_Struct API Functions

Source: https://fukuchi.org/works/qrencode/manual/globals_func.html

Functions for managing structured append QR input data.

```APIDOC
## QRinput_Struct API Functions

### Description
Provides functions for creating and managing structured append QR input data.

### Functions

- **QRinput_Struct_new(int nr)
  * Description: Creates a new structured append input structure.
  * Parameters:
    * nr (int): The number of structures in the append.
  * Returns: QRinput_Struct* - Pointer to the new structured input structure, or NULL on failure.
  * File: qrencode.h

- **QRinput_Struct_free(QRinput_Struct *struct_input)
  * Description: Frees the memory allocated for a structured append input structure.
  * Parameters:
    * struct_input (QRinput_Struct*): Pointer to the structured input structure to free.
  * File: qrencode.h

- **QRinput_Struct_appendInput(QRinput_Struct *struct_input, QRinput *input)
  * Description: Appends a QR input structure to a structured append input structure.
  * Parameters:
    * struct_input (QRinput_Struct*): Pointer to the structured input structure.
    * input (QRinput*): Pointer to the QR input structure to append.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_Struct_insertStructuredAppendHeaders(QRinput_Struct *struct_input)
  * Description: Inserts structured append headers into the input structures.
  * Parameters:
    * struct_input (QRinput_Struct*): Pointer to the structured input structure.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

- **QRinput_Struct_setParity(QRinput_Struct *struct_input, int sn, int parity)
  * Description: Sets the parity for a specific structure within the structured append input.
  * Parameters:
    * struct_input (QRinput_Struct*): Pointer to the structured input structure.
    * sn (int): The structure number (0-based).
    * parity (int): The parity value.
  * Returns: int - 0 on success, -1 on failure.
  * File: qrencode.h

```

--------------------------------

### QRcode API Functions

Source: https://fukuchi.org/works/qrencode/manual/globals_func.html

This section lists the core API functions for QR code generation and management.

```APIDOC
## QRcode API Functions

### Description
Provides functions for QR code generation, manipulation, and management.

### Functions

- **QRcode_APIVersion()**
  * Description: Gets the API version.
  * File: qrencode.h

- **QRcode_APIVersionString()**
  * Description: Gets the API version as a string.
  * File: qrencode.h

- **QRcode_clearCache()**
  * Description: Clears the internal cache.
  * File: qrencode.h

- **QRcode_encodeData(const QRinput *input, QRecLevel level)
  * Description: Encodes input data into a QR code.
  * Parameters:
    * input (QRinput*): The input data structure.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeDataMQR(const QRinput *input, QRecLevel level)
  * Description: Encodes input data into a Micro QR code.
  * Parameters:
    * input (QRinput*): The input data structure.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated Micro QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeDataStructured(const QRinput *input, QRecLevel level)
  * Description: Encodes input data into a QR code with structured append.
  * Parameters:
    * input (QRinput*): The input data structure.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeInput(const QRinput *input, QRecLevel level)
  * Description: Encodes input data into a QR code.
  * Parameters:
    * input (QRinput*): The input data structure.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeInputStructured(const QRinput *input, QRecLevel level)
  * Description: Encodes input data into a QR code with structured append.
  * Parameters:
    * input (QRinput*): The input data structure.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeString(const char *string, int width, QRecLevel level, QRencodeMode hint, QRencodeConvertMode convert)
  * Description: Encodes a string into a QR code.
  * Parameters:
    * string (const char*): The string to encode.
    * width (int): The desired width of the QR code.
    * level (QRecLevel): The error correction level.
    * hint (QRencodeMode): Encoding mode hint.
    * convert (QRencodeConvertMode): Conversion mode.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeString8bit(const char *string, int width, QRecLevel level)
  * Description: Encodes an 8-bit string into a QR code.
  * Parameters:
    * string (const char*): The string to encode.
    * width (int): The desired width of the QR code.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeString8bitMQR(const char *string, int width, QRecLevel level)
  * Description: Encodes an 8-bit string into a Micro QR code.
  * Parameters:
    * string (const char*): The string to encode.
    * width (int): The desired width of the QR code.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated Micro QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeString8bitStructured(const char *string, int width, QRecLevel level)
  * Description: Encodes an 8-bit string into a QR code with structured append.
  * Parameters:
    * string (const char*): The string to encode.
    * width (int): The desired width of the QR code.
    * level (QRecLevel): The error correction level.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeStringMQR(const char *string, int width, QRecLevel level, QRencodeMode hint, QRencodeConvertMode convert)
  * Description: Encodes a string into a Micro QR code.
  * Parameters:
    * string (const char*): The string to encode.
    * width (int): The desired width of the QR code.
    * level (QRecLevel): The error correction level.
    * hint (QRencodeMode): Encoding mode hint.
    * convert (QRencodeConvertMode): Conversion mode.
  * Returns: QRcode* - Pointer to the generated Micro QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_encodeStringStructured(const char *string, int width, QRecLevel level, QRencodeMode hint, QRencodeConvertMode convert)
  * Description: Encodes a string into a QR code with structured append.
  * Parameters:
    * string (const char*): The string to encode.
    * width (int): The desired width of the QR code.
    * level (QRecLevel): The error correction level.
    * hint (QRencodeMode): Encoding mode hint.
    * convert (QRencodeConvertMode): Conversion mode.
  * Returns: QRcode* - Pointer to the generated QR code, or NULL on failure.
  * File: qrencode.h

- **QRcode_free(QRcode *qrcode)
  * Description: Frees the memory allocated for a QR code.
  * Parameters:
    * qrcode (QRcode*): Pointer to the QR code to free.
  * File: qrencode.h

```

--------------------------------

### QRcode_encodeStringStructured

Source: https://fukuchi.org/works/qrencode/manual/index.html

Generates a list of structured-appended QR code symbols from a given input string.

```APIDOC
## QRcode_encodeStringStructured

### Description
Creates structured symbols from the input string, allowing large data to be split into multiple QR codes.

### Parameters
- **string** (const char *) - Required - The input string to encode.
- **version** (int) - Required - The QR code version.
- **level** (QRecLevel) - Required - The error correction level.
- **hint** (QRencodeMode) - Required - Encoding mode hint.
- **casesensitive** (int) - Required - Boolean flag for case sensitivity.

### Response
- **QRcode_List*** - A singly-linked list of QRcode objects.
```

--------------------------------

### QRcode_List_free

Source: https://fukuchi.org/works/qrencode/manual/index.html

Frees the memory associated with a QRcode_List structure.

```APIDOC
## QRcode_List_free

### Description
Frees the memory allocated for a QRcode_List.

### Parameters
- **qrlist** (QRcode_List *) - Required - The list to be freed.
```

--------------------------------

### Iterate over structured-appended QR codes

Source: https://fukuchi.org/works/qrencode/manual/index.html

Demonstrates how to traverse a QRcode_List returned by QRcode_encodeStringStructured to process individual QR code symbols.

```c
QRcode_List *qrcodes;
QRcode_List *entry;
QRcode *qrcode;
qrcodes = QRcode_encodeStringStructured(...);
entry = qrcodes;
while(entry != NULL) {
qrcode = entry->code;
// do something
entry = entry->next;
}
QRcode_List_free(entry);
```

--------------------------------

### QRcode_List API Functions

Source: https://fukuchi.org/works/qrencode/manual/globals_func.html

Functions for managing lists of QR codes.

```APIDOC
## QRcode_List API Functions

### Description
Provides functions for managing lists of QR codes.

### Functions

- **QRcode_List_size(const QRcode_List *list)
  * Description: Gets the number of QR codes in a list.
  * Parameters:
    * list (const QRcode_List*): Pointer to the QR code list.
  * Returns: int - The number of QR codes in the list.
  * File: qrencode.h

- **QRcode_List_free(QRcode_List *list)
  * Description: Frees the memory allocated for a QR code list.
  * Parameters:
    * list (QRcode_List*): Pointer to the QR code list to free.
  * File: qrencode.h

```

--------------------------------

### Encode String in 8-bit Mode with QRcode_encodeString8bit()

Source: https://fukuchi.org/works/qrencode/manual

Encodes a whole string in 8-bit mode. This is an alternative to QRcode_encodeString() when you want to ensure all characters are treated as 8-bit data.

```c
QRcode_encodeString8bit(string, version, level);
```

--------------------------------

### Encode String with QRcode_encodeString()

Source: https://fukuchi.org/works/qrencode/manual

Encodes a given string into a QR Code symbol. The string is automatically parsed. Use QR_MODE_KANJI hint for Shift-JIS Kanji characters. Non-alphanumeric characters are encoded as 8-bit data by default.

```c
QRcode_encodeString(string, version, level, hint, casesensitive);
```

--------------------------------

### Generate Structured-Appended Symbols with QRcode_encodeStringStructured()

Source: https://fukuchi.org/works/qrencode/manual

Generates multiple QR Code symbols for a single large dataset, enabling concatenation by QR code readers. This function returns a linked list of QRcode objects.

```c
QRcode_List *QRcode_encodeStringStructured(const char *string, int version, QRecLevel level, QRencodeMode hint, int casesensitive);
```

--------------------------------

### Append QRinput to QRinput_Struct

Source: https://fukuchi.org/works/qrencode/manual

Appends a QRinput object to a QRinput_Struct. This is part of the process for creating structured-append QR codes, where each QRinput represents a segment of the data.

```c
QRinput_Struct_appendInput(QRinput_Struct *struct, QRinput *input);
```

--------------------------------

### Encode Raw Data with QRcode_encodeData()

Source: https://fukuchi.org/works/qrencode/manual

Encodes raw data, which may contain NUL characters. Use this function when your data is not a standard C string and might include embedded null terminators.

```c
QRcode_encodeData(data, length, version, level);
```

--------------------------------

### Insert Structured Append Headers

Source: https://fukuchi.org/works/qrencode/manual

Inserts appropriate headers into each symbol for structured-append QR codes. This function should be called once before encoding symbols to ensure correct formatting for multi-symbol data sets.

```c
QRinput_Struct_insertStructuredAppendHeaders(QRinput_Struct *struct);
```

--------------------------------

### Free QRcode_List Memory

Source: https://fukuchi.org/works/qrencode/manual

Frees the memory allocated for a QRcode_List, which is a linked list of QRcode objects. This function should be called after processing the list to prevent memory leaks.

```c
void QRcode_List_free(QRcode_List *qrlist);
```
Tokens:
Raw