Naming consistency for encode functions; organize deprecated encode functions
This adds encode-with-string-label functions with names ending in "SZ" so all encode-with-string-label functions end is "SZ".
The former functions that didn't end in "SZ" are retained for backwards compatibility.
All the deprecated encode functions are grouped together and so marked making it easier to read the documentation of the non-deprecated encode functions.
The deprecated functions will never be removed from QCBOR as they aren't that much of a burden, and backwards compatibility is critical.
* Encode function naming consistency for string labels
* more comment fixes; tests; small rearrangement
* switch everything to non-deprecated functions
* Remove line of kruft
---------
Co-authored-by: Laurence Lundblade <lgl@securitytheory.com>
diff --git a/src/qcbor_encode.c b/src/qcbor_encode.c
index 7657303..c30cbce 100644
--- a/src/qcbor_encode.c
+++ b/src/qcbor_encode.c
@@ -693,8 +693,8 @@
* To output a mantissa that is between INT64_MAX and UINT64_MAX from 0,
* it must be as a big number.
*
- * Typically, QCBOREncode_AddDecimalFraction(), QCBOREncode_AddBigFloat(),
- * QCBOREncode_AddDecimalFractionBigNum() or QCBOREncode_AddBigFloatBigNum()
+ * Typically, QCBOREncode_AddTDecimalFraction(), QCBOREncode_AddTBigFloat(),
+ * QCBOREncode_AddTDecimalFractionBigNum() or QCBOREncode_AddTBigFloatBigNum()
* is called instead of this.
*/
void
@@ -718,9 +718,9 @@
QCBOREncode_AddInt64(pMe, nExponent);
if(!UsefulBuf_IsNULLC(BigNumMantissa)) {
if(bBigNumIsNegative) {
- QCBOREncode_AddNegativeBignum(pMe, BigNumMantissa);
+ QCBOREncode_AddTNegativeBignum(pMe, QCBOR_ENCODE_AS_TAG, BigNumMantissa);
} else {
- QCBOREncode_AddPositiveBignum(pMe, BigNumMantissa);
+ QCBOREncode_AddTPositiveBignum(pMe, QCBOR_ENCODE_AS_TAG, BigNumMantissa);
}
} else {
QCBOREncode_AddInt64(pMe, nMantissa);
@@ -968,7 +968,7 @@
return;
}
/* QCBOREncode_CancelBstrWrap() can't correctly undo
- * QCBOREncode_BstrWrapInMap() or QCBOREncode_BstrWrapInMapN(). It
+ * QCBOREncode_BstrWrapInMapSZ() or QCBOREncode_BstrWrapInMapN(). It
* can't undo the labels they add. It also doesn't catch the error
* of using it this way. QCBOREncode_CancelBstrWrap() is used
* infrequently and the the result is incorrect CBOR, not a