UE4QRcode第三方库

/** * qrencode - QR Code encoder * * Copyright (C) 2006-2012 Kentaro Fukuchi <kentaro@fukuchi.org> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ /** \mainpage * Libqrencode is a library for encoding data in a QR Code symbol, a kind of 2D * symbology. * * \section encoding Encoding * * There are two methods to encode data: <b>encoding a string/data</b> or * <b>encoding a structured data</b>. * * \subsection encoding-string Encoding a string/data * You can encode a string by calling QRcode_encodeString(). * The given string is parsed automatically and encoded. If you want to encode * data that can be represented as a C string style (NUL terminated), you can * simply use this way. * * If the input data contains Kanji (Shift-JIS) characters and you want to * encode them as Kanji in QR Code, you should give QR_MODE_KANJI as a hint. * Otherwise, all of non-alphanumeric characters are encoded as 8 bit data. * If you want to encode a whole string in 8 bit mode, you can use * QRcode_encodeString8bit() instead. * * Please note that a C string can not contain NUL characters. If your data * contains NUL, you must use QRcode_encodeData(). * * \subsection encoding-input Encoding a structured data * You can construct a structured input data manually. If the structure of the * input data is known, you can use this way. * At first, create a ::QRinput object by QRinput_new(). Then add input data * to the QRinput object by QRinput_append(). Finally call QRcode_encodeInput() * to encode the QRinput data. * You can reuse the QRinput data again to encode it in other symbols with * different parameters. * * \section result Result * The encoded symbol is resulted as a ::QRcode object. It will contain * its version number, width of the symbol and an array represents the symbol. * See ::QRcode for the details. You can free the object by QRcode_free(). * * Please note that the version of the result may be larger than specified. * In such cases, the input data would be too large to be encoded in a * symbol of the specified version. * * \section structured Structured append * Libqrencode can generate "Structured-appended" symbols that enables to split * a large data set into mulitple QR codes. A QR code reader concatenates * multiple QR code symbols into a string. * Just like QRcode_encodeString(), you can use QRcode_encodeStringStructured() * to generate structured-appended symbols. This functions returns an instance * of ::QRcode_List. The returned list is a singly-linked list of QRcode: you * can retrieve each QR code in this way: * * \code * 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); * \endcode * * Instead of using auto-parsing functions, you can construct your own * structured input. At first, instantiate an object of ::QRinput_Struct * by calling QRinput_Struct_new(). This object can hold multiple ::QRinput, * and one QR code is generated for a ::QRinput. * QRinput_Struct_appendInput() appends a ::QRinput to a ::QRinput_Struct * object. In order to generate structured-appended symbols, it is required to * embed headers to each symbol. You can use * QRinput_Struct_insertStructuredAppendHeaders() to insert appropriate * headers to each symbol. You should call this function just once before * encoding symbols. */ #ifndef __QRENCODE_H__ #define __QRENCODE_H__ #if defined(__cplusplus) extern "C" { #endif /** * Encoding mode. */ typedef enum { QR_MODE_NUL = -1, ///< Terminator (NUL character). Internal use only QR_MODE_NUM = 0, ///< Numeric mode QR_MODE_AN, ///< Alphabet-numeric mode QR_MODE_8, ///< 8-bit data mode QR_MODE_KANJI, ///< Kanji (shift-jis) mode QR_MODE_STRUCTURE, ///< Internal use only QR_MODE_ECI, ///< ECI mode QR_MODE_FNC1FIRST, ///< FNC1, first position QR_MODE_FNC1SECOND, ///< FNC1, second position } QRencodeMode; /** * Level of error correction. */ typedef enum { QR_ECLEVEL_L = 0, ///< lowest QR_ECLEVEL_M, QR_ECLEVEL_Q, QR_ECLEVEL_H ///< highest } QRecLevel; /** * Maximum version (size) of QR-code symbol. */ #define QRSPEC_VERSION_MAX 40 /** * Maximum version (size) of QR-code symbol. */ #define MQRSPEC_VERSION_MAX 4 /****************************************************************************** * Input data (qrinput.c) *****************************************************************************/ /** * Singly linked list to contain input strings. An instance of this class * contains its version and error correction level too. It is required to * set them by QRinput_setVersion() and QRinput_setErrorCorrectionLevel(), * or use QRinput_new2() to instantiate an object. */ typedef struct _QRinput QRinput; /** * Instantiate an input data object. The version is set to 0 (auto-select) * and the error correction level is set to QR_ECLEVEL_L. * @return an input object (initialized). On error, NULL is returned and errno * is set to indicate the error. * @throw ENOMEM unable to allocate memory. */ extern QRinput *QRinput_new(void); /** * Instantiate an input data object. * @param version version number. * @param level Error correction level. * @return an input object (initialized). On error, NULL is returned and errno * is set to indicate the error. * @throw ENOMEM unable to allocate memory for input objects. * @throw EINVAL invalid arguments. */ extern QRinput *QRinput_new2(int version, QRecLevel level); /** * Instantiate an input data object. Object's Micro QR Code flag is set. * Unlike with full-sized QR Code, version number must be specified (>0). * @param version version number (1--4). * @param level Error correction level. * @return an input object (initialized). On error, NULL is returned and errno * is set to indicate the error. * @throw ENOMEM unable to allocate memory for input objects. * @throw EINVAL invalid arguments. */ extern QRinput *QRinput_newMQR(int version, QRecLevel level); /** * Append data to an input object. * The data is copied and appended to the input object. * @param input input object. * @param mode encoding mode. * @param size size of data (byte). * @param data a pointer to the memory area of the input data. * @retval 0 success. * @retval -1 an error occurred and errno is set to indeicate the error. * See Execptions for the details. * @throw ENOMEM unable to allocate memory. * @throw EINVAL input data is invalid. * */ extern int QRinput_append(QRinput *input, QRencodeMode mode, int size, const unsigned char *data); /** * Append ECI header. * @param input input object. * @param ecinum ECI indicator number (0 - 999999) * @retval 0 success. * @retval -1 an error occurred and errno is set to indeicate the error. * See Execptions for the details. * @throw ENOMEM unable to allocate memory. * @throw EINVAL input data is invalid. * */ extern int QRinput_appendECIheader(QRinput *input, unsigned int ecinum); /** * Get current version. * @param input input object. * @return current version. */ extern int QRinput_getVe