qcbor_spiffy_decode.h

Go to the documentation of this file.

/* ==========================================================================
 * qcbor_spiffy_decode.h -- higher-level easier-to-use CBOR decoding.
 *
 * Copyright (c) 2020-2024, Laurence Lundblade. All rights reserved.
 * Copyright (c) 2021, Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * See BSD-3-Clause license in file named "LICENSE"
 *
 * Forked from qcbor_decode.h on 7/23/2020
 * ========================================================================== */
 
#ifndef qcbor_spiffy_decode_h
#define qcbor_spiffy_decode_h
 
#include "qcbor/qcbor_spiffy_decode.h"
#include "qcbor/qcbor_number_decode.h" /* For v1 compatibility, not dependency */
 
 
#ifdef __cplusplus
extern "C" {
#if 0
} // Keep editor indention formatting happy
#endif
#endif
 
 
 
static void
QCBORDecode_GetByteString(QCBORDecodeContext *pCtx,
                          UsefulBufC         *pBytes);
 
static void
QCBORDecode_GetByteStringInMapN(QCBORDecodeContext *pCtx,
                                int64_t             nLabel,
                                UsefulBufC         *pBytes);
 
static void
QCBORDecode_GetByteStringInMapSZ(QCBORDecodeContext *pCtx,
                                 const char         *szLabel,
                                 UsefulBufC         *pBytes);
 
 
static void
QCBORDecode_GetTextString(QCBORDecodeContext *pCtx,
                          UsefulBufC         *pText);
 
static void
QCBORDecode_GetTextStringInMapN(QCBORDecodeContext *pCtx,
                                int64_t             nLabel,
                                UsefulBufC         *pText);
 
static void
QCBORDecode_GetTextStringInMapSZ(QCBORDecodeContext *pCtx,
                                 const char         *szLabel,
                                 UsefulBufC         *pText);
 
 
 
 
static void
QCBORDecode_EnterArray(QCBORDecodeContext *pCtx, QCBORItem *pItem);
 
void
QCBORDecode_EnterArrayFromMapN(QCBORDecodeContext *pMe, int64_t uLabel);
 
void
QCBORDecode_EnterArrayFromMapSZ(QCBORDecodeContext *pMe, const char *szLabel);
 
 
static void
QCBORDecode_ExitArray(QCBORDecodeContext *pCtx);
 
 
static void
QCBORDecode_GetArray(QCBORDecodeContext *pCtx,
                     QCBORItem          *pItem,
                     UsefulBufC         *pEncodedCBOR);
 
static void
QCBORDecode_GetArrayFromMapN(QCBORDecodeContext *pCtx,
                             int64_t             nLabel,
                             QCBORItem          *pItem,
                             UsefulBufC         *pEncodedCBOR);
 
static void
QCBORDecode_GetArrayFromMapSZ(QCBORDecodeContext *pCtx,
                              const char         *szLabel,
                              QCBORItem          *pItem,
                              UsefulBufC         *pEncodedCBOR);
 
 
 
static void
QCBORDecode_EnterMap(QCBORDecodeContext *pCtx, QCBORItem *pItem);
 
void
QCBORDecode_EnterMapFromMapN(QCBORDecodeContext *pCtx, int64_t nLabel);
 
void
QCBORDecode_EnterMapFromMapSZ(QCBORDecodeContext *pCtx, const char *szLabel);
 
 
static void
QCBORDecode_ExitMap(QCBORDecodeContext *pCtx);
 
 
static void
QCBORDecode_GetMap(QCBORDecodeContext *pCtx,
                   QCBORItem          *pItem,
                   UsefulBufC         *pEncodedCBOR);
 
static void
QCBORDecode_GetMapFromMapN(QCBORDecodeContext *pCtx,
                           int64_t             nLabel,
                           QCBORItem          *pItem,
                           UsefulBufC         *pEncodedCBOR);
 
static void
QCBORDecode_GetMapFromMapSZ(QCBORDecodeContext *pCtx,
                            const char         *szLabel,
                            QCBORItem          *pItem,
                            UsefulBufC         *pEncodedCBOR);
 
 
void
QCBORDecode_Rewind(QCBORDecodeContext *pCtx);
 
 
void
QCBORDecode_SeekToLabelN(QCBORDecodeContext *pCtx, int64_t nLabel);
 
 
void
QCBORDecode_SeekToLabelSZ(QCBORDecodeContext *pMe, const char *szLabel);
 
 
void
QCBORDecode_GetItemInMapN(QCBORDecodeContext *pCtx,
                          int64_t             nLabel,
                          uint8_t             uQcborType,
                          QCBORItem          *pItem);
 
void
QCBORDecode_GetItemInMapSZ(QCBORDecodeContext *pCtx,
                           const char         *szLabel,
                           uint8_t             uQcborType,
                           QCBORItem          *pItem);
 
 
void
QCBORDecode_GetItemsInMap(QCBORDecodeContext *pCtx, QCBORItem *pItemList);
 
 
typedef QCBORError (*QCBORItemCallback)(void            *pCallbackCtx,
                                        const QCBORItem *pItem);
 
 
void
QCBORDecode_GetItemsInMapWithCallback(QCBORDecodeContext *pCtx,
                                      QCBORItem          *pItemList,
                                      void               *pCallbackCtx,
                                      QCBORItemCallback   pfCB);
 
void
QCBORDecode_GetBool(QCBORDecodeContext *pCtx, bool *pbBool);
 
void
QCBORDecode_GetBoolInMapN(QCBORDecodeContext *pCtx,
                          int64_t             nLabel,
                          bool               *pbBool);
 
void
QCBORDecode_GetBoolInMapSZ(QCBORDecodeContext *pCtx,
                           const char         *szLabel,
                           bool               *pbBool);
 
 
static void
QCBORDecode_GetNull(QCBORDecodeContext *pCtx);
 
static void
QCBORDecode_GetNullInMapN(QCBORDecodeContext *pCtx, int64_t nLabel);
 
static void
QCBORDecode_GetNullInMapSZ(QCBORDecodeContext *pCtx, const char *szLabel);
 
 
static void
QCBORDecode_GetUndefined(QCBORDecodeContext *pCtx);
 
static void
QCBORDecode_GetUndefinedInMapN(QCBORDecodeContext *pCtx, int64_t nLabel);
 
static void
QCBORDecode_GetUndefinedInMapSZ(QCBORDecodeContext *pCtx, const char *szLabel);
 
 
void
QCBORDecode_GetSimple(QCBORDecodeContext *pCtx, uint8_t *puSimpleValue);
 
void
QCBORDecode_GetSimpleInMapN(QCBORDecodeContext *pCtx,
                            int64_t             nLabel,
                            uint8_t            *puSimpleValue);
 
void
QCBORDecode_GetSimpleInMapSZ(QCBORDecodeContext *pCtx,
                             const char         *szLabel,
                             uint8_t            *puSimpleValue);
 
 
 
 
 
 
/* ========================================================================= *
 *    BEGINNING OF PRIVATE INLINE IMPLEMENTATION                             *
 * ========================================================================= */
 
void
QCBORDecode_Private_EnterBoundedMapOrArray(QCBORDecodeContext *pCtx,
                                           uint8_t             uType,
                                           QCBORItem          *pItem);
 
void
QCBORDecode_Private_ExitBoundedMapOrArray(QCBORDecodeContext *pCtx,
                                          uint8_t             uType);
 
void
QCBORDecode_Private_GetArrayOrMap(QCBORDecodeContext *pCtx,
                                  uint8_t             uType,
                                  QCBORItem          *pItem,
                                  UsefulBufC         *pEncodedCBOR);
 
void
QCBORDecode_Private_SearchAndGetArrayOrMap(QCBORDecodeContext *pCtx,
                                           QCBORItem          *pTarget,
                                           QCBORItem          *pItem,
                                           UsefulBufC         *pEncodedCBOR);
 
typedef struct {
   void               *pCBContext;
   QCBORItemCallback   pfCallback;
} MapSearchCallBack;
 
typedef struct {
   size_t   uStartOffset;
   uint16_t uItemCount;
} MapSearchInfo;
 
QCBORError
QCBORDecode_Private_MapSearch(QCBORDecodeContext *pMe,
                              QCBORItem          *pItemArray,
                              MapSearchInfo      *pInfo,
                              MapSearchCallBack  *pCallBack);
 
QCBORError
QCBORDecode_Private_ExitBoundedLevel(QCBORDecodeContext *pMe,
                                     const uint32_t      uEndOffset);
 
 
void
QCBORDecode_Private_GetItemInMapNoCheckSZ(QCBORDecodeContext *pMe,
                                          const char         *szLabel,
                                          const uint8_t       uQcborType,
                                          QCBORItem          *pItem,
                                          size_t             *puOffset);
 
void
QCBORDecode_Private_GetItemInMapNoCheckN(QCBORDecodeContext *pMe,
                                         const int64_t       nLabel,
                                         const uint8_t       uQcborType,
                                         QCBORItem          *pItem,
                                         size_t             *puOffset);
 
 
static inline void
QCBORDecode_EnterMap(QCBORDecodeContext *pMe, QCBORItem *pItem) {
   QCBORDecode_Private_EnterBoundedMapOrArray(pMe, QCBOR_TYPE_MAP, pItem);
}
 
static inline void
QCBORDecode_EnterArray(QCBORDecodeContext *pMe, QCBORItem *pItem) {
   QCBORDecode_Private_EnterBoundedMapOrArray(pMe, QCBOR_TYPE_ARRAY, pItem);
}
 
 
static inline void
QCBORDecode_ExitArray(QCBORDecodeContext *pMe)
{
   QCBORDecode_Private_ExitBoundedMapOrArray(pMe, QCBOR_TYPE_ARRAY);
}
 
static inline void
QCBORDecode_ExitMap(QCBORDecodeContext *pMe)
{
   QCBORDecode_Private_ExitBoundedMapOrArray(pMe, QCBOR_TYPE_MAP);
}
 
 
static inline void
QCBORDecode_GetArray(QCBORDecodeContext *pMe,
                     QCBORItem          *pItem,
                     UsefulBufC         *pEncodedCBOR)
{
   QCBORDecode_Private_GetArrayOrMap(pMe, QCBOR_TYPE_ARRAY, pItem, pEncodedCBOR);
}
 
 
static inline void
QCBORDecode_GetArrayFromMapN(QCBORDecodeContext *pMe,
                             const int64_t       nLabel,
                             QCBORItem          *pItem,
                             UsefulBufC         *pEncodedCBOR)
{
   QCBORItem OneItemSeach[2];
   OneItemSeach[0].uLabelType  = QCBOR_TYPE_INT64;
   OneItemSeach[0].label.int64 = nLabel;
   OneItemSeach[0].uDataType   = QCBOR_TYPE_ARRAY;
   OneItemSeach[1].uLabelType  = QCBOR_TYPE_NONE;
 
   QCBORDecode_Private_SearchAndGetArrayOrMap(pMe, OneItemSeach, pItem, pEncodedCBOR);
}
 
 
static inline void
QCBORDecode_GetArrayFromMapSZ(QCBORDecodeContext *pMe,
                              const char         *szLabel,
                              QCBORItem          *pItem,
                              UsefulBufC         *pEncodedCBOR)
{
#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
   QCBORItem OneItemSeach[2];
   OneItemSeach[0].uLabelType   = QCBOR_TYPE_TEXT_STRING;
   OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
   OneItemSeach[0].uDataType    = QCBOR_TYPE_ARRAY;
   OneItemSeach[1].uLabelType   = QCBOR_TYPE_NONE;
 
   QCBORDecode_Private_SearchAndGetArrayOrMap(pMe, OneItemSeach, pItem, pEncodedCBOR);
#else
   (void)szLabel;
   (void)pItem;
   (void)pEncodedCBOR;
   pMe->uLastError =  QCBOR_ERR_MAP_LABEL_TYPE;
#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
}
 
static inline void
QCBORDecode_GetMap(QCBORDecodeContext *pMe,
                   QCBORItem          *pItem,
                   UsefulBufC         *pEncodedCBOR)
{
   QCBORDecode_Private_GetArrayOrMap(pMe, QCBOR_TYPE_MAP, pItem, pEncodedCBOR);
}
 
 
static inline void
QCBORDecode_GetMapFromMapN(QCBORDecodeContext *pMe,
                           const int64_t       nLabel,
                           QCBORItem          *pItem,
                           UsefulBufC         *pEncodedCBOR)
{
   QCBORItem OneItemSeach[2];
   OneItemSeach[0].uLabelType  = QCBOR_TYPE_INT64;
   OneItemSeach[0].label.int64 = nLabel;
   OneItemSeach[0].uDataType   = QCBOR_TYPE_MAP;
   OneItemSeach[1].uLabelType  = QCBOR_TYPE_NONE;
 
   QCBORDecode_Private_SearchAndGetArrayOrMap(pMe, OneItemSeach, pItem, pEncodedCBOR);
}
 
 
static inline void
QCBORDecode_GetMapFromMapSZ(QCBORDecodeContext *pMe,
                            const char         *szLabel,
                            QCBORItem          *pItem,
                            UsefulBufC         *pEncodedCBOR)
{
#ifndef QCBOR_DISABLE_NON_INTEGER_LABELS
   QCBORItem OneItemSeach[2];
   OneItemSeach[0].uLabelType   = QCBOR_TYPE_TEXT_STRING;
   OneItemSeach[0].label.string = UsefulBuf_FromSZ(szLabel);
   OneItemSeach[0].uDataType    = QCBOR_TYPE_MAP;
   OneItemSeach[1].uLabelType   = QCBOR_TYPE_NONE;
 
   QCBORDecode_Private_SearchAndGetArrayOrMap(pMe, OneItemSeach, pItem, pEncodedCBOR);
#else
   (void)szLabel;
   (void)pItem;
   (void)pEncodedCBOR;
   pMe->uLastError =  QCBOR_ERR_MAP_LABEL_TYPE;
#endif /* ! QCBOR_DISABLE_NON_INTEGER_LABELS */
}
 
 
 
 
static inline void
QCBORDecode_GetByteString(QCBORDecodeContext *pMe, UsefulBufC *pBytes)
{
   QCBORItem  Item;
 
   QCBORDecode_VGetNext(pMe, &Item);
 
   if(pMe->uLastError == QCBOR_SUCCESS && Item.uDataType == QCBOR_TYPE_BYTE_STRING) {
      *pBytes = Item.val.string;
   } else {
      *pBytes = NULLUsefulBufC;
   }
}
 
static inline void
QCBORDecode_GetByteStringInMapN(QCBORDecodeContext *pMe,
                                const int64_t       nLabel,
                                UsefulBufC         *pBytes)
{
   QCBORItem  Item;
 
   QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_BYTE_STRING, &Item);
 
   if(pMe->uLastError == QCBOR_SUCCESS) {
      *pBytes = Item.val.string;
   } else {
      *pBytes = NULLUsefulBufC;
   }
}
 
static inline void
QCBORDecode_GetByteStringInMapSZ(QCBORDecodeContext *pMe,
                                 const char         *szLabel,
                                 UsefulBufC         *pBytes)
{
   QCBORItem  Item;
 
   QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_BYTE_STRING, &Item);
 
   if(pMe->uLastError == QCBOR_SUCCESS) {
      *pBytes = Item.val.string;
   } else {
      *pBytes = NULLUsefulBufC;
   }
}
 
 
static inline void
QCBORDecode_GetTextString(QCBORDecodeContext *pMe, UsefulBufC *pText)
{
   QCBORItem  Item;
 
   QCBORDecode_VGetNext(pMe, &Item);
 
   if(pMe->uLastError == QCBOR_SUCCESS && Item.uDataType == QCBOR_TYPE_TEXT_STRING) {
      *pText = Item.val.string;
   } else {
      *pText = NULLUsefulBufC;
   }
}
 
static inline void
QCBORDecode_GetTextStringInMapN(QCBORDecodeContext *pMe,
                                const int64_t       nLabel,
                                UsefulBufC         *pText)
{
   QCBORItem  Item;
 
   QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_TEXT_STRING, &Item);
 
   if(pMe->uLastError == QCBOR_SUCCESS) {
      *pText = Item.val.string;
   } else {
      *pText = NULLUsefulBufC;
   }
}
 
static inline void
QCBORDecode_GetTextStringInMapSZ(QCBORDecodeContext *pMe,
                                 const char         *szLabel,
                                 UsefulBufC         *pText)
{
   QCBORItem  Item;
 
   QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_TEXT_STRING, &Item);
 
   if(pMe->uLastError == QCBOR_SUCCESS) {
      *pText = Item.val.string;
   } else {
      *pText = NULLUsefulBufC;
   }
}
 
 
static inline void
QCBORDecode_GetNull(QCBORDecodeContext *pMe)
{
   QCBORItem item;
 
   QCBORDecode_VGetNext(pMe, &item);
   if(pMe->uLastError == QCBOR_SUCCESS && item.uDataType != QCBOR_TYPE_NULL) {
      pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
   }
}
 
static inline void
QCBORDecode_GetNullInMapN(QCBORDecodeContext *pMe,
                          const int64_t       nLabel)
{
   QCBORItem Item;
   QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_NULL, &Item);
}
 
static inline void
QCBORDecode_GetNullInMapSZ(QCBORDecodeContext *pMe,
                           const char         *szLabel)
{
   QCBORItem Item;
   QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_NULL, &Item);
}
 
static inline void
QCBORDecode_GetUndefined(QCBORDecodeContext *pMe)
{
   QCBORItem item;
 
   QCBORDecode_VGetNext(pMe, &item);
   if(pMe->uLastError == QCBOR_SUCCESS && item.uDataType != QCBOR_TYPE_UNDEF) {
      pMe->uLastError = QCBOR_ERR_UNEXPECTED_TYPE;
   }
}
 
static inline void
QCBORDecode_GetUndefinedInMapN(QCBORDecodeContext *pMe,
                               const int64_t       nLabel)
{
   QCBORItem Item;
   QCBORDecode_GetItemInMapN(pMe, nLabel, QCBOR_TYPE_UNDEF, &Item);
}
 
static inline void
QCBORDecode_GetUndefinedInMapSZ(QCBORDecodeContext *pMe,
                                const char         *szLabel)
{
   QCBORItem Item;
   QCBORDecode_GetItemInMapSZ(pMe, szLabel, QCBOR_TYPE_UNDEF, &Item);
}
 
 
/* ======================================================================== *
 *    END OF PRIVATE INLINE IMPLEMENTATION                                  *
 * ======================================================================== */
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* qcbor_spiffy_decode_h */