Tidy comments in qcbor_common.h (#125)
Some private stuff was moved out of qcbor_common.h to qcbor_private.h. All the comments are now /* */, not //. Grammar check on qcbor_common.h
* more comment fix ups
* grammar, formatting
* All comments /* */
* line spacing
---------
Co-authored-by: Laurence Lundblade <lgl@securitytheory.com>
diff --git a/inc/qcbor/qcbor_common.h b/inc/qcbor/qcbor_common.h
index 25c629c..b4afb37 100644
--- a/inc/qcbor/qcbor_common.h
+++ b/inc/qcbor/qcbor_common.h
@@ -1,35 +1,35 @@
-/*==============================================================================
- Copyright (c) 2016-2018, The Linux Foundation.
- Copyright (c) 2018-2022, Laurence Lundblade.
- Copyright (c) 2021, Arm Limited.
- All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above
- copyright notice, this list of conditions and the following
- disclaimer in the documentation and/or other materials provided
- with the distribution.
- * Neither the name of The Linux Foundation nor the names of its
- contributors, nor the name "Laurence Lundblade" may be used to
- endorse or promote products derived from this software without
- specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
-BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
-BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
-IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- =============================================================================*/
+/* ==========================================================================
+ * Copyright (c) 2016-2018, The Linux Foundation.
+ * Copyright (c) 2018-2023, Laurence Lundblade.
+ * Copyright (c) 2021, Arm Limited.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution.
+ * * Neither the name of The Linux Foundation nor the names of its
+ * contributors, nor the name "Laurence Lundblade" may be used to
+ * endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ========================================================================= */
#ifndef qcbor_common_h
@@ -45,10 +45,11 @@
/**
- @file qcbor_common.h
-
- Types and defines common to QCBOR encoding and decoding.
-*/
+ * @file qcbor_common.h
+ *
+ * Constant values for types, error codes and such that are common to
+ * encoding and decoding.
+ */
/**
@@ -76,46 +77,26 @@
#define QCBOR_SPIFFY_DECODE
-/* It was originally defined as QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA,
- * but this is incosistent with all the other QCBOR_DISABLE_
- * #defines, so the name was changed and this was added for backwards
- * compatibility
- */
-#ifdef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
-#define QCBOR_DISABLE_EXP_AND_MANTISSA
-#endif
-/* If USEFULBUF_DISABLE_ALL_FLOATis defined then define
- * QCBOR_DISABLE_FLOAT_HW_USE and QCBOR_DISABLE_PREFERRED_FLOAT
- */
-#ifdef USEFULBUF_DISABLE_ALL_FLOAT
-#ifndef QCBOR_DISABLE_FLOAT_HW_USE
-#define QCBOR_DISABLE_FLOAT_HW_USE
-#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
-#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
-#define QCBOR_DISABLE_PREFERRED_FLOAT
-#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
-#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
-
-/* Standard CBOR Major type for positive integers of various lengths */
+/* Standard CBOR Major type for positive integers of various lengths. */
#define CBOR_MAJOR_TYPE_POSITIVE_INT 0
-/* Standard CBOR Major type for negative integer of various lengths */
+/* Standard CBOR Major type for negative integer of various lengths. */
#define CBOR_MAJOR_TYPE_NEGATIVE_INT 1
/* Standard CBOR Major type for an array of arbitrary 8-bit bytes. */
#define CBOR_MAJOR_TYPE_BYTE_STRING 2
/* Standard CBOR Major type for a UTF-8 string. Note this is true 8-bit UTF8
- with no encoding and no NULL termination */
+ * with no encoding and no NULL termination. */
#define CBOR_MAJOR_TYPE_TEXT_STRING 3
-/* Standard CBOR Major type for an ordered array of other CBOR data items */
+/* Standard CBOR Major type for an ordered array of other CBOR data items. */
#define CBOR_MAJOR_TYPE_ARRAY 4
/* Standard CBOR Major type for CBOR MAP. Maps an array of pairs. The
- first item in the pair is the "label" (key, name or identfier) and the second
- item is the value. */
+ * first item in the pair is the "label" (key, name or identfier) and the second
+ * item is the value. */
#define CBOR_MAJOR_TYPE_MAP 5
/* Standard CBOR major type for a tag number. This creates a CBOR "tag" that
@@ -128,35 +109,16 @@
#define CBOR_MAJOR_TYPE_TAG 6
#define CBOR_MAJOR_TYPE_OPTIONAL 6
-/* Standard CBOR extra simple types like floats and the values true and false */
+/* Standard CBOR simple types like float, the values true, false, null... */
#define CBOR_MAJOR_TYPE_SIMPLE 7
-/*
- These are special values for the AdditionalInfo bits that are part of
- the first byte. Mostly they encode the length of the data item.
- */
-#define LEN_IS_ONE_BYTE 24
-#define LEN_IS_TWO_BYTES 25
-#define LEN_IS_FOUR_BYTES 26
-#define LEN_IS_EIGHT_BYTES 27
-#define ADDINFO_RESERVED1 28
-#define ADDINFO_RESERVED2 29
-#define ADDINFO_RESERVED3 30
-#define LEN_IS_INDEFINITE 31
/*
- 24 is a special number for CBOR. Integers and lengths
- less than it are encoded in the same byte as the major type.
- */
-#define CBOR_TWENTY_FOUR 24
-
-
-/*
- Tags that are used with CBOR_MAJOR_TYPE_OPTIONAL. These
- are types defined in RFC 8949 and some additional ones
- in the IANA CBOR tags registry.
+ * Tags that are used with CBOR_MAJOR_TYPE_OPTIONAL. These
+ * are types defined in RFC 8949 and some additional ones
+ * in the IANA CBOR tags registry.
*/
/** See QCBOREncode_AddDateString(). */
#define CBOR_TAG_DATE_STRING 0
@@ -167,48 +129,47 @@
/** See QCBOREncode_AddNegativeBignum(). */
#define CBOR_TAG_NEG_BIGNUM 3
/** CBOR tag for a two-element array representing a fraction with a
- mantissa and base-10 scaling factor. See QCBOREncode_AddDecimalFraction()
- and @ref expAndMantissa.
- */
+ * mantissa and base-10 scaling factor. See
+ * QCBOREncode_AddDecimalFraction() and @ref expAndMantissa. */
#define CBOR_TAG_DECIMAL_FRACTION 4
/** CBOR tag for a two-element array representing a fraction with a
- mantissa and base-2 scaling factor. See QCBOREncode_AddBigFloat()
- and @ref expAndMantissa. */
+ * mantissa and base-2 scaling factor. See QCBOREncode_AddBigFloat()
+ * and @ref expAndMantissa. */
#define CBOR_TAG_BIGFLOAT 5
-/** Not Decoded by QCBOR. Tag for COSE format encryption with no recipient
- identification. See [RFC 8152, COSE]
- (https://tools.ietf.org/html/rfc8152). No API is provided for this
- tag. */
+/** Not Decoded by QCBOR. Tag for COSE format encryption with no
+ * recipient identification. See [RFC 8152, COSE]
+ * (https://tools.ietf.org/html/rfc8152). No API is provided for this
+ * tag. */
#define CBOR_TAG_COSE_ENCRYPT0 16
#define CBOR_TAG_COSE_ENCRYPTO 16
-/** Not Decoded by QCBOR. Tag for COSE format MAC'd data with no recipient
- identification. See [RFC 8152, COSE]
- (https://tools.ietf.org/html/rfc8152). No API is provided for this
- tag.*/
+/** Not Decoded by QCBOR. Tag for COSE format MAC'd data with no
+ * recipient identification. See [RFC 8152, COSE]
+ * (https://tools.ietf.org/html/rfc8152). No API is provided for this
+ * tag. */
#define CBOR_TAG_COSE_MAC0 17
/** Tag for COSE format single signature signing. No API is provided
- for this tag. See [RFC 8152, COSE]
- (https://tools.ietf.org/html/rfc8152). */
+ * for this tag. See [RFC 8152, COSE]
+ * (https://tools.ietf.org/html/rfc8152). */
#define CBOR_TAG_COSE_SIGN1 18
/** A hint that the following byte string should be encoded in
- Base64URL when converting to JSON or similar text-based
- representations. Call @c
- QCBOREncode_AddTag(pCtx,CBOR_TAG_ENC_AS_B64URL) before the call to
- QCBOREncode_AddBytes(). */
+ * Base64URL when converting to JSON or similar text-based
+ * representations. Call @c
+ * QCBOREncode_AddTag(pCtx,CBOR_TAG_ENC_AS_B64URL) before the call to
+ * QCBOREncode_AddBytes(). */
#define CBOR_TAG_ENC_AS_B64URL 21
/** A hint that the following byte string should be encoded in Base64
- when converting to JSON or similar text-based
- representations. Call @c
- QCBOREncode_AddTag(pCtx,CBOR_TAG_ENC_AS_B64) before the call to
- QCBOREncode_AddBytes(). */
+ * when converting to JSON or similar text-based
+ * representations. Call @c
+ * QCBOREncode_AddTag(pCtx,CBOR_TAG_ENC_AS_B64) before the call to
+ * QCBOREncode_AddBytes(). */
#define CBOR_TAG_ENC_AS_B64 22
/** A hint that the following byte string should be encoded in base-16
- format per [RFC 4648] (https://tools.ietf.org/html/rfc4648) when
- converting to JSON or similar text-based
- representations. Essentially, Base-16 encoding is the standard
- case- insensitive hex encoding and may be referred to as
- "hex". Call @c QCBOREncode_AddTag(pCtx,CBOR_TAG_ENC_AS_B16) before
- the call to QCBOREncode_AddBytes(). */
+ * format per [RFC 4648] (https://tools.ietf.org/html/rfc4648) when
+ * converting to JSON or similar text-based
+ * representations. Essentially, Base-16 encoding is the standard
+ * case- insensitive hex encoding and may be referred to as
+ * "hex". Call @c QCBOREncode_AddTag(pCtx,CBOR_TAG_ENC_AS_B16) before
+ * the call to QCBOREncode_AddBytes(). */
#define CBOR_TAG_ENC_AS_B16 23
/** See QCBORDecode_EnterBstrWrapped()). */
#define CBOR_TAG_CBOR 24
@@ -225,17 +186,16 @@
/** See QCBOREncode_AddBinaryUUID(). */
#define CBOR_TAG_BIN_UUID 37
/** The data is a CBOR Web Token per [RFC 8392]
- (https://tools.ietf.org/html/rfc8932). No API is provided for this
- tag. */
+ * (https://tools.ietf.org/html/rfc8932). No API is provided for this
+ * tag. */
#define CBOR_TAG_CWT 61
/** Tag for COSE format encryption. See [RFC 8152, COSE]
- (https://tools.ietf.org/html/rfc8152). No API is provided for this
- tag. */
+ * (https://tools.ietf.org/html/rfc8152). No API is provided for this
+ * tag. */
#define CBOR_TAG_CBOR_SEQUENCE 63
-/** Not Decoded by QCBOR. Tag for COSE format encryption with recipient
- identification. See [RFC 8152, COSE]
- (https://tools.ietf.org/html/rfc8152). No API is provided for this
- tag. */
+/** Not Decoded by QCBOR. Tag for COSE format encrypt. See [RFC 8152, COSE]
+ * (https://tools.ietf.org/html/rfc8152). No API is provided for this
+ * tag. */
#define CBOR_TAG_COSE_ENCRYPT 96
#define CBOR_TAG_ENCRYPT 96
/** Not Decoded by QCBOR. Tag for COSE format MAC. See [RFC 8152, COSE]
@@ -249,21 +209,21 @@
#define CBOR_TAG_COSE_SIGN 98
#define CBOR_TAG_SIGN 98
/** Tag for date counted by days from Jan 1 1970 per [RFC 8943]
- (https://tools.ietf.org/html/rfc8943). See
- QCBOREncode_AddTDaysEpoch(). */
+ * (https://tools.ietf.org/html/rfc8943). See
+ * QCBOREncode_AddTDaysEpoch(). */
#define CBOR_TAG_DAYS_EPOCH 100
/** Not Decoded by QCBOR. World geographic coordinates. See ISO 6709, [RFC 5870]
- (https://tools.ietf.org/html/rfc5870) and WGS-84. No API is
- provided for this tag. */
+ * (https://tools.ietf.org/html/rfc5870) and WGS-84. No API is
+ * provided for this tag. */
#define CBOR_TAG_GEO_COORD 103
/** Binary MIME.*/
#define CBOR_TAG_BINARY_MIME 257
/** Tag for date string without time or time zone per [RFC 8943]
- (https://tools.ietf.org/html/rfc8943). See
- QCBOREncode_AddTDaysString(). */
+ * (https://tools.ietf.org/html/rfc8943). See
+ * QCBOREncode_AddTDaysString(). */
#define CBOR_TAG_DAYS_STRING 1004
/** The magic number, self-described CBOR. No API is provided for this
- tag. */
+ * tag. */
#define CBOR_TAG_CBOR_MAGIC 55799
/** The 16-bit invalid tag from the CBOR tags registry */
@@ -275,28 +235,11 @@
-/*
- Values for the 5 bits for items of major type 7
- */
-#define CBOR_SIMPLEV_FALSE 20
-#define CBOR_SIMPLEV_TRUE 21
-#define CBOR_SIMPLEV_NULL 22
-#define CBOR_SIMPLEV_UNDEF 23
-#define CBOR_SIMPLEV_ONEBYTE 24
-#define HALF_PREC_FLOAT 25
-#define SINGLE_PREC_FLOAT 26
-#define DOUBLE_PREC_FLOAT 27
-#define CBOR_SIMPLE_BREAK 31
-#define CBOR_SIMPLEV_RESERVED_START CBOR_SIMPLEV_ONEBYTE
-#define CBOR_SIMPLEV_RESERVED_END CBOR_SIMPLE_BREAK
-
-
-
/**
* Error codes returned by QCBOR Encoder and Decoder.
*
- * The errors are grouped to keep the code size of
+ * They are grouped to keep the code size of
* QCBORDecode_IsNotWellFormedError() and
* QCBORDecode_IsUnrecoverableError() minimal.
*
@@ -310,307 +253,311 @@
* added for new QCBOR features.
*/
typedef enum {
- /** The encode or decode completely correctly. */
+ /** The encode or decode completed correctly. */
QCBOR_SUCCESS = 0,
/** The buffer provided for the encoded output when doing encoding
- was too small and the encoded output will not fit. */
+ * was too small and the encoded output will not fit. */
QCBOR_ERR_BUFFER_TOO_SMALL = 1,
/** During encoding, an attempt to create simple value between 24
- and 31. */
+ * and 31. */
QCBOR_ERR_ENCODE_UNSUPPORTED = 2,
/** During encoding, the length of the encoded CBOR exceeded
- QCBOR_MAX_ARRAY_OFFSET, which is slightly less than
- @c UINT32_MAX. */
+ * @ref QCBOR_MAX_ARRAY_OFFSET, which is slightly less than
+ * @c UINT32_MAX. */
QCBOR_ERR_BUFFER_TOO_LARGE = 3,
/** During encoding, the array or map nesting was deeper than this
- implementation can handle. Note that in the interest of code
- size and memory use, this implementation has a hard limit on
- array nesting. The limit is defined as the constant @ref
- QCBOR_MAX_ARRAY_NESTING. */
+ * implementation can handle. Note that in the interest of code
+ * size and memory use, QCBOR has a hard limit on array
+ * nesting. The limit is defined as the constant
+ * @ref QCBOR_MAX_ARRAY_NESTING. */
QCBOR_ERR_ARRAY_NESTING_TOO_DEEP = 4,
- /** During encoding, @c QCBOREncode_CloseXxx() called with a
- different type than is currently open. */
+ /** During encoding, @c QCBOREncode_CloseXxx() called for a
+ * different type than is currently open. */
QCBOR_ERR_CLOSE_MISMATCH = 5,
/** During encoding, the array or map had too many items in it.
- This limit @ref QCBOR_MAX_ITEMS_IN_ARRAY, typically 65,535. */
+ * This limit @ref QCBOR_MAX_ITEMS_IN_ARRAY, typically 65,535. */
QCBOR_ERR_ARRAY_TOO_LONG = 6,
/** During encoding, more arrays or maps were closed than
- opened. This is a coding error on the part of the caller of the
- encoder. */
+ * opened. This is a coding error on the part of the caller of the
+ * encoder. */
QCBOR_ERR_TOO_MANY_CLOSES = 7,
- /** During encoding the number of array or map opens was not
- matched by the number of closes. Also occurs with opened
- byte strings that are not closed. */
+ /** During encoding, the number of array or map opens was not
+ * matched by the number of closes. Also occurs with opened byte
+ * strings that are not closed. */
QCBOR_ERR_ARRAY_OR_MAP_STILL_OPEN = 8,
- /** During encode, opening a byte string while a byte string is open
- is not allowed. . */
+ /** During encoding, opening a byte string while a byte string is
+ * open is not allowed. */
QCBOR_ERR_OPEN_BYTE_STRING = 9,
/** Trying to cancel a byte string wrapping after items have been
- added to it. */
+ * added to it. */
QCBOR_ERR_CANNOT_CANCEL = 10,
#define QCBOR_START_OF_NOT_WELL_FORMED_ERRORS 20
/** During decoding, the CBOR is not well-formed because a simple
- value between 0 and 31 is encoded in a two-byte integer rather
- than one. */
+ * value between 0 and 31 is encoded in a two-byte integer rather
+ * than one. */
QCBOR_ERR_BAD_TYPE_7 = 20,
/** During decoding, returned by QCBORDecode_Finish() if all the
- inputs bytes have not been consumed. This is considered not
- well-formed. */
+ * inputs bytes have not been consumed. This is considered not
+ * well-formed. */
QCBOR_ERR_EXTRA_BYTES = 21,
/** During decoding, some CBOR construct was encountered that this
- decoder doesn't support, primarily this is the reserved
- additional info values, 28 through 30. The CBOR is not
- well-formed.*/
+ * decoder doesn't support, primarily this is the reserved
+ * additional info values, 28 through 30. The CBOR is not
+ * well-formed.
+ */
QCBOR_ERR_UNSUPPORTED = 22,
/** During decoding, the an array or map was not fully consumed.
- Returned by QCBORDecode_Finish(). The CBOR is not
- well-formed. */
+ * Returned by QCBORDecode_Finish(). The CBOR is not
+ * well-formed. */
QCBOR_ERR_ARRAY_OR_MAP_UNCONSUMED = 23,
/** During decoding, an integer type is encoded with a bad length
- (that of an indefinite length string). The CBOR is not-well
- formed. */
+ * (that of an indefinite length string). The CBOR is not-well
+ * formed. */
QCBOR_ERR_BAD_INT = 24,
#define QCBOR_START_OF_UNRECOVERABLE_DECODE_ERRORS 30
/** During decoding, one of the chunks in an indefinite-length
- string is not of the type of the start of the string. The CBOR
- is not well-formed. This error makes no further decoding
- possible. */
+ * string is not of the type of the start of the string. The CBOR
+ * is not well-formed. This error makes no further decoding
+ * possible. */
QCBOR_ERR_INDEFINITE_STRING_CHUNK = 30,
/** During decoding, hit the end of the given data to decode. For
- example, a byte string of 100 bytes was expected, but the end
- of the input was hit before finding those 100 bytes. Corrupted
- CBOR input will often result in this error. See also @ref
- QCBOR_ERR_NO_MORE_ITEMS. The CBOR is not well-formed. This
- error makes no further decoding possible. */
+ * example, a byte string of 100 bytes was expected, but the end
+ * of the input was hit before finding those 100 bytes. Corrupted
+ * CBOR input will often result in this error. See also
+ * @ref QCBOR_ERR_NO_MORE_ITEMS. The CBOR is not well-formed.
+ * This error makes no further decoding possible. */
QCBOR_ERR_HIT_END = 31,
/** During decoding, a break occurred outside an indefinite-length
- item. The CBOR is not well-formed. This error makes no further
- decoding possible. */
+ * item. The CBOR is not well-formed. This error makes no further
+ * decoding possible. */
QCBOR_ERR_BAD_BREAK = 32,
#define QCBOR_END_OF_NOT_WELL_FORMED_ERRORS 39
/** During decoding, the input is too large. It is greater than
- QCBOR_MAX_DECODE_INPUT_SIZE. This is an implementation limit.
- This error makes no further decoding possible. */
+ * QCBOR_MAX_DECODE_INPUT_SIZE. This is an implementation limit.
+ * This error makes no further decoding possible. */
QCBOR_ERR_INPUT_TOO_LARGE = 40,
/** During decoding, the array or map nesting was deeper than this
- implementation can handle. Note that in the interest of code
- size and memory use, this implementation has a hard limit on
- array nesting. The limit is defined as the constant @ref
- QCBOR_MAX_ARRAY_NESTING. This error makes no further decoding
- possible. */
+ * implementation can handle. Note that in the interest of code
+ * size and memory use, QCBOR has a hard limit on array
+ * nesting. The limit is defined as the constant
+ * @ref QCBOR_MAX_ARRAY_NESTING. This error makes no further
+ * decoding possible. */
QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP = 41,
/** During decoding, the array or map had too many items in it.
- This limit @ref QCBOR_MAX_ITEMS_IN_ARRAY, typically 65,534,
- UINT16_MAX - 1. This error makes no further decoding
- possible. */
+ * This limit @ref QCBOR_MAX_ITEMS_IN_ARRAY, typically 65,534,
+ * UINT16_MAX - 1. This error makes no further decoding
+ * possible. */
QCBOR_ERR_ARRAY_DECODE_TOO_LONG = 42,
/** When decoding, a string's size is greater than what a size_t
- can hold less 4. In all but some very strange situations this
- is because of corrupt input CBOR and should be treated as
- such. The strange situation is a CPU with a very small size_t
- (e.g., a 16-bit CPU) and a large string (e.g., > 65KB). This
- error makes no further decoding possible. */
+ * can hold less 4. In all but some very strange situations this
+ * is because of corrupt input CBOR and should be treated as
+ * such. The strange situation is a CPU with a very small size_t
+ * (e.g., a 16-bit CPU) and a large string (e.g., > 65KB). This
+ * error makes no further decoding possible. */
QCBOR_ERR_STRING_TOO_LONG = 43,
/** Something is wrong with a decimal fraction or bigfloat such as
- it not consisting of an array with two integers. This error
- makes no further decoding possible. */
+ * it not consisting of an array with two integers. This error
+ * makes no further decoding possible. */
QCBOR_ERR_BAD_EXP_AND_MANTISSA = 44,
/** Unable to decode an indefinite-length string because no string
- allocator was configured. See QCBORDecode_SetMemPool() or
- QCBORDecode_SetUpAllocator(). This error makes no further
- decoding possible. */
+ * allocator was configured. See QCBORDecode_SetMemPool() or
+ * QCBORDecode_SetUpAllocator(). This error makes no further
+ * decoding possible.*/
QCBOR_ERR_NO_STRING_ALLOCATOR = 45,
/** Error allocating space for a string, usually for an
- indefinite-length string. This error makes no further decoding
- possible. */
+ * indefinite-length string. This error makes no further decoding
+ * possible. */
QCBOR_ERR_STRING_ALLOCATE = 46,
/** During decoding, the type of the label for a map entry is not
- one that can be handled in the current decoding mode. Typically
- this is because a label is not an intger or a string. This is
- an implemation limit. */
+ * one that can be handled in the current decoding mode. Typically
+ * this is because a label is not an integer or a string. This is
+ * an implementation limit. */
QCBOR_ERR_MAP_LABEL_TYPE = 47,
/** When the built-in tag decoding encounters an unexpected type,
- this error is returned. This error is unrecoverable because the
- built-in tag decoding doesn't try to consume the unexpected
- type. In previous versions of QCBOR this was considered a
- recoverable error hence QCBOR_ERR_BAD_TAG_CONTENT. Going back
- further, RFC 7049 use the name "optional tags". That name is no
- longer used because "optional" was causing confusion. See
- also @ref QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT. */
+ * this error is returned. This error is unrecoverable because the
+ * built-in tag decoding doesn't try to consume the unexpected
+ * type. In previous versions of QCBOR this was considered a
+ * recoverable error hence @ref QCBOR_ERR_BAD_TAG_CONTENT. Going
+ * back further, RFC 7049 use the name "optional tags". That name
+ * is no longer used because "optional" was causing confusion. See
+ * also @ref QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT. */
QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT = 48,
QCBOR_ERR_BAD_TAG_CONTENT = 48,
QCBOR_ERR_BAD_OPT_TAG = 48,
/** Indefinite length string handling is disabled and there is an
- indefinite length string in the input CBOR. */
+ * indefinite length string in the input CBOR. */
QCBOR_ERR_INDEF_LEN_STRINGS_DISABLED = 49,
- /** Indefinite length arrays and maps handling are disabled and there is an
- indefinite length map or array in the input CBOR. */
+ /** Indefinite length arrays and maps handling are disabled and
+ * there is an indefinite length map or array in the input
+ * CBOR. */
QCBOR_ERR_INDEF_LEN_ARRAYS_DISABLED = 50,
/** All decoding of tags (major type 6) has been disabled and a tag
- occurred in the decode input. */
+ * occurred in the decode input. */
QCBOR_ERR_TAGS_DISABLED = 51,
#define QCBOR_END_OF_UNRECOVERABLE_DECODE_ERRORS 59
/** More than @ref QCBOR_MAX_TAGS_PER_ITEM tags encountered for a
- CBOR ITEM. @ref QCBOR_MAX_TAGS_PER_ITEM is a limit of this
- implementation. During decoding, too many tags in the
- caller-configured tag list, or not enough space in @ref
- QCBORTagListOut. This error makes no further decoding
- possible. */
+ * CBOR ITEM. @ref QCBOR_MAX_TAGS_PER_ITEM is a limit of this
+ * implementation. During decoding, too many tags in the
+ * caller-configured tag list, or not enough space in
+ * @ref QCBORTagListOut. This error makes no further decoding
+ * possible. */
QCBOR_ERR_TOO_MANY_TAGS = 60,
- /** When decoding for a specific type, the type was not was
- expected. */
+ /** When decoding for a specific type, the type was not expected. */
QCBOR_ERR_UNEXPECTED_TYPE = 61,
- /** Duplicate label in map detected. */
+ /** Duplicate label detected in a map. */
QCBOR_ERR_DUPLICATE_LABEL = 62,
/** During decoding, the buffer given to QCBORDecode_SetMemPool()
- is either too small, smaller than
- QCBOR_DECODE_MIN_MEM_POOL_SIZE or too large, larger than
- UINT32_MAX. */
+ * is either too small, smaller than
+ * @ref QCBOR_DECODE_MIN_MEM_POOL_SIZE or too large, larger than
+ * UINT32_MAX. */
QCBOR_ERR_MEM_POOL_SIZE = 63,
/** During decoding, an integer smaller than INT64_MIN was received
- (CBOR can represent integers smaller than INT64_MIN, but C
- cannot). */
+ * (CBOR can represent integers smaller than INT64_MIN, but C
+ * cannot). */
QCBOR_ERR_INT_OVERFLOW = 64,
/** During decoding, a date greater than +- 292 billion years from
- Jan 1 1970 encountered during parsing. This is an
- implementation limit. */
+ * Jan 1 1970 encountered during parsing. This is an
+ * implementation limit. */
QCBOR_ERR_DATE_OVERFLOW = 65,
/** During decoding, @c QCBORDecode_ExitXxx() was called for a
- different type than @c QCBORDecode_EnterXxx(). */
+ * different type than @c QCBORDecode_EnterXxx(). */
QCBOR_ERR_EXIT_MISMATCH = 66,
/** All well-formed data items have been consumed and there are no
- more. If parsing a CBOR stream this indicates the non-error end
- of the stream. If not parsing a CBOR stream / sequence, this
- probably indicates that some data items expected are not
- present. See also @ref QCBOR_ERR_HIT_END. */
+ * more. If parsing a CBOR stream this indicates the non-error end
+ * of the stream. If not parsing a CBOR stream/sequence, this
+ * probably indicates that some data items expected are not
+ * present. See also @ref QCBOR_ERR_HIT_END. */
QCBOR_ERR_NO_MORE_ITEMS = 67,
/** When finding an item by label, an item with the requested label
- was not found. */
+ * was not found. */
QCBOR_ERR_LABEL_NOT_FOUND = 68,
/** Number conversion failed because of sign. For example a
- negative int64_t can't be converted to a uint64_t */
+ * negative int64_t can't be converted to a uint64_t */
QCBOR_ERR_NUMBER_SIGN_CONVERSION = 69,
- /** When converting a decoded number, the value is too large or to
- small for the conversion target */
+ /** When converting a decoded number, the value is too large or too
+ * small for the conversion target. */
QCBOR_ERR_CONVERSION_UNDER_OVER_FLOW = 70,
/** Trying to get an item by label when a map has not been
- entered. */
+ * entered. */
QCBOR_ERR_MAP_NOT_ENTERED = 71,
- /** A @ref QCBORItemCallback callback indicates processing should not
- continue for some non-CBOR reason. */
+ /** A callback indicates processing should not continue for some
+ * non-CBOR reason. */
QCBOR_ERR_CALLBACK_FAIL = 72,
/** This error code is deprecated. Instead,
- @ref QCBOR_ERR_HALF_PRECISION_DISABLED,
- @ref QCBOR_ERR_HW_FLOAT_DISABLED or @ref QCBOR_ERR_ALL_FLOAT_DISABLED
- is returned depending on the specific floating-point functionality
- that is disabled and the type of floating-point input. */
+ * @ref QCBOR_ERR_HALF_PRECISION_DISABLED,
+ * @ref QCBOR_ERR_HW_FLOAT_DISABLED or @ref QCBOR_ERR_ALL_FLOAT_DISABLED
+ * is returned depending on the specific floating-point functionality
+ * that is disabled and the type of floating-point input. */
QCBOR_ERR_FLOAT_DATE_DISABLED = 73,
/** Support for half-precision float decoding is disabled. */
QCBOR_ERR_HALF_PRECISION_DISABLED = 74,
/** Use of floating-point HW is disabled. This affects all type
- conversions to and from double and float types. */
+ * conversions to and from double and float types. */
QCBOR_ERR_HW_FLOAT_DISABLED = 75,
/** Unable to complete operation because a floating-point value
- that is a NaN (not a number), that is too large, too small,
- infinity or -infinity was encountered in encoded CBOR. Usually
- this because conversion of the float-point value was being
- attempted. */
+ * that is a NaN (not a number), that is too large, too small,
+ * infinity or -infinity was encountered in encoded CBOR. Usually
+ * this because conversion of the float-point value was being
+ * attempted. */
QCBOR_ERR_FLOAT_EXCEPTION = 76,
- /** Floating point support is completely turned off, encoding/decoding
- floating point numbers is not possible. */
+ /** Floating point support is completely turned off,
+ * encoding/decoding floating point numbers is not possible. */
QCBOR_ERR_ALL_FLOAT_DISABLED = 77,
/** Like @ref QCBOR_ERR_UNRECOVERABLE_TAG_CONTENT, but recoverable.
- If an implementation decodes a tag and can and does consume the
- whole tag contents when it is not the correct tag content, this
- error can be returned. None of the built-in tag decoders do
- this (to save object code). */
+ * If an implementation decodes a tag and can and does consume the
+ * whole tag contents when it is not the correct tag content, this
+ * error can be returned. None of the built-in tag decoders do this
+ * (to save object code). */
QCBOR_ERR_RECOVERABLE_BAD_TAG_CONTENT = 78
/* This is stored in uint8_t; never add values > 255 */
} QCBORError;
-/* Function for getting an error string from an error code */
+/**
+ * @brief Get string describing an error code.
+ *
+ * @param[in] err The error code.
+ *
+ * @return NULL-terminated string describing error or "Unidentified
+ * error" if the error is not known.
+ */
const char *qcbor_err_to_str(QCBORError err);
+
/**
- The maximum nesting of arrays and maps when encoding or decoding. The
- error @ref QCBOR_ERR_ARRAY_NESTING_TOO_DEEP will be returned on
- encoding or QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP on decoding if it is exceeded.
+ * The maximum nesting of arrays and maps when encoding or
+ * decoding. The error @ref QCBOR_ERR_ARRAY_NESTING_TOO_DEEP will be
+ * returned on encoding or @ref QCBOR_ERR_ARRAY_DECODE_NESTING_TOO_DEEP on
+ * decoding if it is exceeded. Do not increase this over 255.
*/
-#define QCBOR_MAX_ARRAY_NESTING QCBOR_MAX_ARRAY_NESTING1
+#define QCBOR_MAX_ARRAY_NESTING 15
/**
- * The maximum number of items in a single array or map when encoding of decoding.
+ * The maximum number of items in a single array or map when encoding or
+ * decoding.
*/
-/* -1 because the value UINT16_MAX is used to track indefinite-length arrays */
-#define QCBOR_MAX_ITEMS_IN_ARRAY (UINT16_MAX-1)
-
-
-/**
- This is deprecated. See QCBORDecode_GetNthTag() and QCBORDecode_GetNthTagOfLast()
- for tag handling.
-
- The maximum number of tags that can be in @ref QCBORTagListIn and passed to
- QCBORDecode_SetCallerConfiguredTagList()
- */
-#define QCBOR_MAX_CUSTOM_TAGS 16
+#define QCBOR_MAX_ITEMS_IN_ARRAY (UINT16_MAX-1) /* -1 is because the
+ * value UINT16_MAX is
+ * used to indicate
+ * indefinite-length.
+ */
#ifdef __cplusplus
diff --git a/inc/qcbor/qcbor_private.h b/inc/qcbor/qcbor_private.h
index 9a2a720..3397b6a 100644
--- a/inc/qcbor/qcbor_private.h
+++ b/inc/qcbor/qcbor_private.h
@@ -1,35 +1,35 @@
-/*==============================================================================
- Copyright (c) 2016-2018, The Linux Foundation.
- Copyright (c) 2018-2021, Laurence Lundblade.
- Copyright (c) 2021, Arm Limited.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are
- met:
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above
- copyright notice, this list of conditions and the following
- disclaimer in the documentation and/or other materials provided
- with the distribution.
- * Neither the name of The Linux Foundation nor the names of its
- contributors, nor the name "Laurence Lundblade" may be used to
- endorse or promote products derived from this software without
- specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
- WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
- BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
- OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
- IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- =============================================================================*/
+/* ==========================================================================
+ * Copyright (c) 2016-2018, The Linux Foundation.
+ * Copyright (c) 2018-2023, Laurence Lundblade.
+ * Copyright (c) 2021, Arm Limited.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution.
+ * * Neither the name of The Linux Foundation nor the names of its
+ * contributors, nor the name "Laurence Lundblade" may be used to
+ * endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ========================================================================= */
#ifndef qcbor_private_h
@@ -38,6 +38,7 @@
#include <stdint.h>
#include "UsefulBuf.h"
+#include "qcbor/qcbor_common.h"
#ifdef __cplusplus
@@ -48,56 +49,52 @@
#endif
-/*
- The maxium nesting of arrays and maps when encoding or decoding.
- (Further down in the file there is a definition that refers to this
- that is public. This is done this way so there can be a nice
- separation of public and private parts in this file.
-*/
-#define QCBOR_MAX_ARRAY_NESTING1 15 // Do not increase this over 255
-
-
-/* The largest offset to the start of an array or map. It is slightly
- less than UINT32_MAX so the error condition can be tested on 32-bit machines.
- UINT32_MAX comes from uStart in QCBORTrackNesting being a uin32_t.
-
- This will cause trouble on a machine where size_t is less than 32-bits.
+/* This was originally defined as QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA,
+ * but this is inconsistent with all the other QCBOR_DISABLE_
+ * #defines, so the name was changed and this was added for backwards
+ * compatibility
*/
-#define QCBOR_MAX_ARRAY_OFFSET (UINT32_MAX - 100)
+#ifdef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
+#define QCBOR_DISABLE_EXP_AND_MANTISSA
+#endif
-
-/* The number of tags that are 16-bit or larger that can be handled
- in a decode.
+/* If USEFULBUF_DISABLE_ALL_FLOATis defined then define
+ * QCBOR_DISABLE_FLOAT_HW_USE and QCBOR_DISABLE_PREFERRED_FLOAT
*/
-#define QCBOR_NUM_MAPPED_TAGS 4
+#ifdef USEFULBUF_DISABLE_ALL_FLOAT
+#ifndef QCBOR_DISABLE_FLOAT_HW_USE
+#define QCBOR_DISABLE_FLOAT_HW_USE
+#endif /* QCBOR_DISABLE_FLOAT_HW_USE */
+#ifndef QCBOR_DISABLE_PREFERRED_FLOAT
+#define QCBOR_DISABLE_PREFERRED_FLOAT
+#endif /* QCBOR_DISABLE_PREFERRED_FLOAT */
+#endif /* USEFULBUF_DISABLE_ALL_FLOAT */
-/* The number of tags (of any size) recorded for an individual item. */
-#define QCBOR_MAX_TAGS_PER_ITEM1 4
/*
- Convenience macro for selecting the proper return value in case floating
- point feature(s) are disabled.
-
- The macros:
-
- FLOAT_ERR_CODE_NO_FLOAT(x) Can be used when disabled floating point should
- result error, and all other cases should return
- 'x'.
-
- The below macros always return QCBOR_ERR_ALL_FLOAT_DISABLED when all floating
- point is disabled.
-
- FLOAT_ERR_CODE_NO_HALF_PREC(x) Can be used when disabled preferred float
- results in error, and all other cases should
- return 'x'.
- FLOAT_ERR_CODE_NO_FLOAT_HW(x) Can be used when disabled hardware floating
- point results in error, and all other cases
- should return 'x'.
- FLOAT_ERR_CODE_NO_HALF_PREC_NO_FLOAT_HW(x) Can be used when either disabled
- preferred float or disabling
- hardware floating point results in
- error, and all other cases should
- return 'x'.
+ * Convenience macro for selecting the proper return value in case floating
+ * point feature(s) are disabled.
+ *
+ * The macros:
+ *
+ * FLOAT_ERR_CODE_NO_FLOAT(x) Can be used when disabled floating point should
+ * result error, and all other cases should return
+ * 'x'.
+ *
+ * The below macros always return QCBOR_ERR_ALL_FLOAT_DISABLED when all
+ * floating point is disabled.
+ *
+ * FLOAT_ERR_CODE_NO_HALF_PREC(x) Can be used when disabled preferred float
+ * results in error, and all other cases should
+ * return 'x'.
+ * FLOAT_ERR_CODE_NO_FLOAT_HW(x) Can be used when disabled hardware floating
+ * point results in error, and all other cases
+ * should return 'x'.
+ * FLOAT_ERR_CODE_NO_HALF_PREC_NO_FLOAT_HW(x) Can be used when either disabled
+ * preferred float or disabling
+ * hardware floating point results in
+ * error, and all other cases should
+ * return 'x'.
*/
#ifdef USEFULBUF_DISABLE_ALL_FLOAT
#define FLOAT_ERR_CODE_NO_FLOAT(x) QCBOR_ERR_ALL_FLOAT_DISABLED
@@ -126,103 +123,163 @@
/*
- PRIVATE DATA STRUCTURE
+ * These are special values for the AdditionalInfo bits that are part of
+ * the first byte. Mostly they encode the length of the data item.
+ */
+#define LEN_IS_ONE_BYTE 24
+#define LEN_IS_TWO_BYTES 25
+#define LEN_IS_FOUR_BYTES 26
+#define LEN_IS_EIGHT_BYTES 27
+#define ADDINFO_RESERVED1 28
+#define ADDINFO_RESERVED2 29
+#define ADDINFO_RESERVED3 30
+#define LEN_IS_INDEFINITE 31
- Holds the data for tracking array and map nesting during encoding. Pairs up
- with the Nesting_xxx functions to make an "object" to handle nesting encoding.
- uStart is a uint32_t instead of a size_t to keep the size of this
- struct down so it can be on the stack without any concern. It would be about
- double if size_t was used instead.
+/*
+ * 24 is a special number for CBOR. Integers and lengths
+ * less than it are encoded in the same byte as the major type.
+ */
+#define CBOR_TWENTY_FOUR 24
- Size approximation (varies with CPU/compiler):
- 64-bit machine: (15 + 1) * (4 + 2 + 1 + 1 pad) + 8 = 136 bytes
- 32-bit machine: (15 + 1) * (4 + 2 + 1 + 1 pad) + 4 = 132 bytes
-*/
+
+/*
+ * Values for the 5 bits for items of major type 7
+ */
+#define CBOR_SIMPLEV_FALSE 20
+#define CBOR_SIMPLEV_TRUE 21
+#define CBOR_SIMPLEV_NULL 22
+#define CBOR_SIMPLEV_UNDEF 23
+#define CBOR_SIMPLEV_ONEBYTE 24
+#define HALF_PREC_FLOAT 25
+#define SINGLE_PREC_FLOAT 26
+#define DOUBLE_PREC_FLOAT 27
+#define CBOR_SIMPLE_BREAK 31
+#define CBOR_SIMPLEV_RESERVED_START CBOR_SIMPLEV_ONEBYTE
+#define CBOR_SIMPLEV_RESERVED_END CBOR_SIMPLE_BREAK
+
+
+/* The largest offset to the start of an array or map. It is slightly
+ * less than UINT32_MAX so the error condition can be tested on 32-bit
+ * machines. UINT32_MAX comes from uStart in QCBORTrackNesting being
+ * a uin32_t.
+ *
+ * This will cause trouble on a machine where size_t is less than 32-bits.
+ */
+#define QCBOR_MAX_ARRAY_OFFSET (UINT32_MAX - 100)
+
+
+/* The number of tags that are 16-bit or larger that can be handled
+ * in a decode.
+ */
+#define QCBOR_NUM_MAPPED_TAGS 4
+
+/* The number of tags (of any size) recorded for an individual item. */
+#define QCBOR_MAX_TAGS_PER_ITEM1 4
+
+
+
+
+/*
+ * PRIVATE DATA STRUCTURE
+ *
+ * Holds the data for tracking array and map nesting during
+ * encoding. Pairs up with the Nesting_xxx functions to make an
+ * "object" to handle nesting encoding.
+ *
+ * uStart is a uint32_t instead of a size_t to keep the size of this
+ * struct down so it can be on the stack without any concern. It
+ * would be about double if size_t was used instead.
+ *
+ * Size approximation (varies with CPU/compiler):
+ * 64-bit machine: (15 + 1) * (4 + 2 + 1 + 1 pad) + 8 = 136 bytes
+ * 32-bit machine: (15 + 1) * (4 + 2 + 1 + 1 pad) + 4 = 132 bytes
+ */
typedef struct __QCBORTrackNesting {
- // PRIVATE DATA STRUCTURE
+ /* PRIVATE DATA STRUCTURE */
struct {
- // See function QCBOREncode_OpenMapOrArray() for details on how this works
- uint32_t uStart; // uStart is the byte position where the array starts
- uint16_t uCount; // Number of items in the arrary or map; counts items
- // in a map, not pairs of items
- uint8_t uMajorType; // Indicates if item is a map or an array
- } pArrays[QCBOR_MAX_ARRAY_NESTING1+1], // stored state for the nesting levels
- *pCurrentNesting; // the current nesting level
+ /* See QCBOREncode_OpenMapOrArray() for details on how this works */
+ uint32_t uStart; /* uStart is the position where the array starts */
+ uint16_t uCount; /* Number of items in the arrary or map; counts items
+ * in a map, not pairs of items */
+ uint8_t uMajorType; /* Indicates if item is a map or an array */
+ } pArrays[QCBOR_MAX_ARRAY_NESTING+1], /* stored state for nesting levels */
+ *pCurrentNesting; /* the current nesting level */
} QCBORTrackNesting;
/*
- PRIVATE DATA STRUCTURE
-
- Context / data object for encoding some CBOR. Used by all encode functions to
- form a public "object" that does the job of encdoing.
-
- Size approximation (varies with CPU/compiler):
- 64-bit machine: 27 + 1 (+ 4 padding) + 136 = 32 + 136 = 168 bytes
- 32-bit machine: 15 + 1 + 132 = 148 bytes
-*/
+ * PRIVATE DATA STRUCTURE
+ *
+ * Context / data object for encoding some CBOR. Used by all encode
+ * functions to form a public "object" that does the job of encdoing.
+ *
+ * Size approximation (varies with CPU/compiler):
+ * 64-bit machine: 27 + 1 (+ 4 padding) + 136 = 32 + 136 = 168 bytes
+ * 32-bit machine: 15 + 1 + 132 = 148 bytes
+ */
struct _QCBOREncodeContext {
- // PRIVATE DATA STRUCTURE
- UsefulOutBuf OutBuf; // Pointer to output buffer, its length and
- // position in it
- uint8_t uError; // Error state, always from QCBORError enum
- QCBORTrackNesting nesting; // Keep track of array and map nesting
+ /* PRIVATE DATA STRUCTURE */
+ UsefulOutBuf OutBuf; /* Pointer to output buffer, its length and
+ * position in it. */
+ uint8_t uError; /* Error state, always from QCBORError enum */
+ QCBORTrackNesting nesting; /* Keep track of array and map nesting */
};
/*
- PRIVATE DATA STRUCTURE
-
- Holds the data for array and map nesting for decoding work. This
- structure and the DecodeNesting_Xxx() functions in qcbor_decode.c
- form an "object" that does the work for arrays and maps. All access
- to this structure is through DecodeNesting_Xxx() functions.
-
- 64-bit machine size
- 128 = 16 * 8 for the two unions
- 64 = 16 * 4 for the uLevelType, 1 byte padded to 4 bytes for alignment
- 16 = 16 bytes for two pointers
- 208 TOTAL
-
- 32-bit machine size is 200 bytes
+ * PRIVATE DATA STRUCTURE
+ *
+ * Holds the data for array and map nesting for decoding work. This
+ * structure and the DecodeNesting_Xxx() functions in qcbor_decode.c
+ * form an "object" that does the work for arrays and maps. All access
+ * to this structure is through DecodeNesting_Xxx() functions.
+ *
+ * 64-bit machine size
+ * 128 = 16 * 8 for the two unions
+ * 64 = 16 * 4 for the uLevelType, 1 byte padded to 4 bytes for alignment
+ * 16 = 16 bytes for two pointers
+ * 208 TOTAL
+ *
+ * 32-bit machine size is 200 bytes
*/
typedef struct __QCBORDecodeNesting {
- // PRIVATE DATA STRUCTURE
+ /* PRIVATE DATA STRUCTURE */
struct nesting_decode_level {
/*
- This keeps tracking info for each nesting level. There are two
- main types of levels:
- 1) Byte count tracking. This is for the top level input CBOR
- which might be a single item or a CBOR sequence and byte
- string wrapped encoded CBOR.
- 2) Item tracking. This is for maps and arrays.
-
- uLevelType has value QCBOR_TYPE_BYTE_STRING for 1) and
- QCBOR_TYPE_MAP or QCBOR_TYPE_ARRAY or QCBOR_TYPE_MAP_AS_ARRAY
- for 2).
-
- Item tracking is either for definite or indefinite-length
- maps/arrays. For definite lengths, the total count and items
- unconsumed are tracked. For indefinite-length, uTotalCount is
- QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH (UINT16_MAX) and there
- is no per-item count of members. For indefinite-length maps and
- arrays, uCountCursor is UINT16_MAX if not consumed and zero if
- it is consumed in the pre-order traversal. Additionally, if
- entered in bounded mode, uCountCursor is
- QCBOR_COUNT_INDICATES_ZERO_LENGTH to indicate it is empty.
-
- This also records whether a level is bounded or not. All
- byte-count tracked levels (the top-level sequence and
- bstr-wrapped CBOR) are bounded. Maps and arrays may or may not
- be bounded. They are bounded if they were Entered() and not if
- they were traversed with GetNext(). They are marked as bounded
- by uStartOffset not being UINT32_MAX.
+ * This keeps tracking info for each nesting level. There are two
+ * main types of levels:
+ * 1) Byte count tracking. This is for the top level input CBOR
+ * which might be a single item or a CBOR sequence and byte
+ * string wrapped encoded CBOR.
+ * 2) Item tracking. This is for maps and arrays.
+ *
+ * uLevelType has value QCBOR_TYPE_BYTE_STRING for 1) and
+ * QCBOR_TYPE_MAP or QCBOR_TYPE_ARRAY or QCBOR_TYPE_MAP_AS_ARRAY
+ * for 2).
+ *
+ * Item tracking is either for definite or indefinite-length
+ * maps/arrays. For definite lengths, the total count and items
+ * unconsumed are tracked. For indefinite-length, uTotalCount is
+ * QCBOR_COUNT_INDICATES_INDEFINITE_LENGTH (UINT16_MAX) and
+ * there is no per-item count of members. For indefinite-length
+ * maps and arrays, uCountCursor is UINT16_MAX if not consumed
+ * and zero if it is consumed in the pre-order
+ * traversal. Additionally, if entered in bounded mode,
+ * uCountCursor is QCBOR_COUNT_INDICATES_ZERO_LENGTH to indicate
+ * it is empty.
+ *
+ * This also records whether a level is bounded or not. All
+ * byte-count tracked levels (the top-level sequence and
+ * bstr-wrapped CBOR) are bounded. Maps and arrays may or may
+ * not be bounded. They are bounded if they were Entered() and
+ * not if they were traversed with GetNext(). They are marked as
+ * bounded by uStartOffset not being UINT32_MAX.
*/
/*
- If uLevelType can put in a separately indexed array, the union/
- struct will be 8 bytes rather than 9 and a lot of wasted
- padding for alignment will be saved.
+ * If uLevelType can put in a separately indexed array, the
+ * union/ struct will be 8 bytes rather than 9 and a lot of
+ * wasted padding for alignment will be saved.
*/
uint8_t uLevelType;
union {
@@ -242,88 +299,89 @@
uint32_t uBstrStartOffset;
} bs; /* for top-level sequence and bstr-wrapped CBOR */
} u;
- } pLevels[QCBOR_MAX_ARRAY_NESTING1+1],
+ } pLevels[QCBOR_MAX_ARRAY_NESTING+1],
*pCurrent,
*pCurrentBounded;
/*
- pCurrent is for item-by-item pre-order traversal.
-
- pCurrentBounded points to the current bounding level or is NULL if
- there isn't one.
-
- pCurrent must always be below pCurrentBounded as the pre-order
- traversal is always bounded by the bounding level.
-
- When a bounded level is entered, the pre-order traversal is set to
- the first item in the bounded level. When a bounded level is
- exited, the pre-order traversl is set to the next item after the
- map, array or bstr. This may be more than one level up, or even
- the end of the input CBOR.
+ * pCurrent is for item-by-item pre-order traversal.
+ *
+ * pCurrentBounded points to the current bounding level or is NULL
+ * if there isn't one.
+ *
+ * pCurrent must always be below pCurrentBounded as the pre-order
+ * traversal is always bounded by the bounding level.
+ *
+ * When a bounded level is entered, the pre-order traversal is set
+ * to the first item in the bounded level. When a bounded level is
+ * exited, the pre-order traversl is set to the next item after the
+ * map, array or bstr. This may be more than one level up, or even
+ * the end of the input CBOR.
*/
} QCBORDecodeNesting;
typedef struct {
- // PRIVATE DATA STRUCTURE
+ /* PRIVATE DATA STRUCTURE */
void *pAllocateCxt;
UsefulBuf (* pfAllocator)(void *pAllocateCxt, void *pOldMem, size_t uNewSize);
} QCBORInternalAllocator;
/*
- PRIVATE DATA STRUCTURE
-
- The decode context. This data structure plus the public QCBORDecode_xxx
- functions form an "object" that does CBOR decoding.
-
- Size approximation (varies with CPU/compiler):
- 64-bit machine: 32 + 1 + 1 + 6 bytes padding + 72 + 16 + 8 + 8 = 144 bytes
- 32-bit machine: 16 + 1 + 1 + 2 bytes padding + 68 + 8 + 8 + 4 = 108 bytes
+ * PRIVATE DATA STRUCTURE
+ *
+ * The decode context. This data structure plus the public
+ * QCBORDecode_xxx functions form an "object" that does CBOR decoding.
+ *
+ * Size approximation (varies with CPU/compiler):
+ * 64-bit machine: 32 + 1 + 1 + 6 bytes padding + 72 + 16 + 8 + 8 = 144 bytes
+ * 32-bit machine: 16 + 1 + 1 + 2 bytes padding + 68 + 8 + 8 + 4 = 108 bytes
*/
struct _QCBORDecodeContext {
- // PRIVATE DATA STRUCTURE
+ /* PRIVATE DATA STRUCTURE */
UsefulInputBuf InBuf;
-
QCBORDecodeNesting nesting;
-
- // If a string allocator is configured for indefinite-length
- // strings, it is configured here.
+ /* If a string allocator is configured for indefinite-length
+ * strings, it is configured here.
+ */
QCBORInternalAllocator StringAllocator;
- // These are special for the internal MemPool allocator.
- // They are not used otherwise. We tried packing these
- // in the MemPool itself, but there are issues
- // with memory alignment.
+ /* These are special for the internal MemPool allocator. They are
+ * not used otherwise. We tried packing these in the MemPool
+ * itself, but there are issues with memory alignment.
+ */
uint32_t uMemPoolSize;
uint32_t uMemPoolFreeOffset;
- // A cached offset to the end of the current map
- // 0 if no value is cached.
+ /* A cached offset to the end of the current map 0 if no value is
+ * cached.
+ */
#define QCBOR_MAP_OFFSET_CACHE_INVALID UINT32_MAX
uint32_t uMapEndOffsetCache;
uint8_t uDecodeMode;
uint8_t bStringAllocateAll;
- uint8_t uLastError; // QCBORError stuffed into a uint8_t
+ uint8_t uLastError; /* QCBORError stuffed into a uint8_t */
/* See MapTagNumber() for description of how tags are mapped. */
uint64_t auMappedTags[QCBOR_NUM_MAPPED_TAGS];
uint16_t uLastTags[QCBOR_MAX_TAGS_PER_ITEM1];
-
};
-// Used internally in the impementation here
-// Must not conflict with any of the official CBOR types
-#define CBOR_MAJOR_NONE_TYPE_RAW 9
-#define CBOR_MAJOR_NONE_TAG_LABEL_REORDER 10
+
+/* Used internally in the impementation here Must not conflict with
+ * any of the official CBOR types
+ */
+#define CBOR_MAJOR_NONE_TYPE_RAW 9
+#define CBOR_MAJOR_NONE_TAG_LABEL_REORDER 10
#define CBOR_MAJOR_NONE_TYPE_BSTR_LEN_ONLY 11
-#define CBOR_MAJOR_NONE_TYPE_OPEN_BSTR 12
+#define CBOR_MAJOR_NONE_TYPE_OPEN_BSTR 12
-// Add this to types to indicate they are to be encoded as indefinite lengths
+/* Add this to types to indicate they are to be encoded as indefinite lengths */
#define QCBOR_INDEFINITE_LEN_TYPE_MODIFIER 0x80
#define CBOR_MAJOR_NONE_TYPE_ARRAY_INDEFINITE_LEN \
CBOR_MAJOR_TYPE_ARRAY + QCBOR_INDEFINITE_LEN_TYPE_MODIFIER
diff --git a/test/qcbor_decode_tests.c b/test/qcbor_decode_tests.c
index 7adb7a2..b3bf91d 100644
--- a/test/qcbor_decode_tests.c
+++ b/test/qcbor_decode_tests.c
@@ -1011,7 +1011,7 @@
UsefulBuf_FROM_BYTE_ARRAY_LITERAL(spTooDeepArrays),
QCBOR_DECODE_MODE_NORMAL);
- for(i = 0; i < QCBOR_MAX_ARRAY_NESTING1; i++) {
+ for(i = 0; i < QCBOR_MAX_ARRAY_NESTING; i++) {
if(QCBORDecode_GetNext(&DCtx, &Item) != 0 ||
Item.uDataType != QCBOR_TYPE_ARRAY ||