Added annotation attribute, more encoding

das-developers · Aug 30, 2024 · 5b471a0 · 5b471a0
1 parent bd7028d
commit 5b471a0
Show file tree

Hide file tree

Showing 18 changed files with 1,448 additions and 1,049 deletions.
diff --git a/das2/codec.c b/das2/codec.c
@@ -917,3 +917,15 @@ int DasCodec_decode(
 
 	return nBufLen - nBytesRead;  /* Return number of unread bytes */
 }
+
+
+/* ************************************************************************* */
+/* Main encoder */
+
+int DasCodec_encode(DasCodec* pThis, DasBuf* pBuf, int nWrite, bool bLast)
+{
+
+	DasBuf_printf(pBuf, "Adding %d values here\n", nWrite);
+	return nWrite;
+
+}
diff --git a/das2/codec.h b/das2/codec.h
@@ -184,7 +184,11 @@ DAS_API int DasCodec_decode(
    DasCodec* pThis, const ubyte* pBuf, int nBufLen, int nExpect, int* pValsRead
 );
 
-/** Write values from an array into a buffer, does not change the array */
+/** Write values from an array into a buffer, does not change the array 
+ * 
+ * @returns The number of values written or a negative ERR code if a data
+ *          conversion error occured.
+ */
 DAS_API int DasCodec_encode(
    DasCodec* pThis, DasBuf* pBuf, int nWrite, bool bLast
 );

diff --git a/das2/dataset.c b/das2/dataset.c
@@ -380,7 +380,7 @@ void _DasDs_codecsGoLarger(DasDs* pThis)
 	pThis->uSzCodecs = uNewSz;
 }
 
-DasErrCode DasDs_addFixedCodec(
+DasCodec* DasDs_addFixedCodec(
 	DasDs* pThis, const char* sAryId, const char* sSemantic, 
 	const char* sEncType, int nItemBytes, int nNumItems
 ){
@@ -395,8 +395,10 @@ DasErrCode DasDs_addFixedCodec(
 
 	/* Find the array with this ID */
 	DasAry* pAry = DasDs_getAryById(pThis, sAryId);
-	if(pAry == NULL)
-		return das_error(DASERR_DS, "An array with id '%s' was not found", sAryId);
+	if(pAry == NULL){
+		das_error(DASERR_DS, "An array with id '%s' was not found", sAryId);
+		return NULL;
+	}
 
 	DasCodec* pCodec = pThis->lCodecs + pThis->uCodecs;
 
@@ -405,15 +407,15 @@ DasErrCode DasDs_addFixedCodec(
 	);
 
 	if(nRet != DAS_OKAY)
-		return nRet;
+		return NULL;
 
 	pThis->lItems[pThis->uCodecs] = nNumItems;
 	pThis->uCodecs += 1;
 
-	return DAS_OKAY;
+	return pCodec;
 }
 
-DasErrCode DasDs_addFixedCodecFrom(
+DasCodec* DasDs_addFixedCodecFrom(
 	DasDs* pThis, const char* sAryId, const DasCodec* pOther, int nNumItems
 ){
 	/* Go dynamic? */
@@ -431,8 +433,10 @@ DasErrCode DasDs_addFixedCodecFrom(
 
 	/* Look for the array in this dataset, not the other one */
 	DasAry* pAry = DasDs_getAryById(pThis, _sFindAry);
-	if(pAry == NULL)
-		return das_error(DASERR_DS, "An array with id '%s' was not found", _sFindAry);
+	if(pAry == NULL){
+		das_error(DASERR_DS, "An array with id '%s' was not found", _sFindAry);
+		return NULL;
+	}
 
 	DasCodec* pDest = pThis->lCodecs + pThis->uCodecs;
 
@@ -444,14 +448,15 @@ DasErrCode DasDs_addFixedCodecFrom(
 	pThis->lItems[pThis->uCodecs] = nNumItems;
 	pThis->uCodecs += 1;
 
-	return DAS_OKAY;
+	return pDest;
 }
 
-DasErrCode DasDs_addRaggedCodec(
+DasCodec* DasDs_addRaggedCodec(
 	DasDs* pThis, const char* sAryId, const char* sSemantic, const char* sEncType, 
 	int nItemBytes, int nSeps, ubyte uSepLen, const ubyte* pSepByIdx
 ){
-	return das_error(DASERR_NOTIMP, "Ragged codec creation not yet implimented");
+	das_error(DASERR_NOTIMP, "Ragged codec creation not yet implimented");
+	return NULL;
 }
 
 int DasDs_recBytes(const DasDs* pThis)
@@ -469,7 +474,7 @@ int DasDs_recBytes(const DasDs* pThis)
 	return nBytesPerPkt;
 }
 
-const DasCodec* DasDs_getCodecFor(
+DasCodec* DasDs_getCodecFor(
 	const DasDs* pThis, const char* sAryId, int* pItems
 ){
 	size_t u;
@@ -485,7 +490,7 @@ const DasCodec* DasDs_getCodecFor(
 		return NULL;
 	}
 
-	const DasCodec* pCodec = NULL;
+	DasCodec* pCodec = NULL;
 	for( u = 0; u < pThis->uCodecs; u++){
 		pCodec = &(pThis->lCodecs[u]);
 		if(pCodec->pAry == pFind){

diff --git a/das2/dataset.h b/das2/dataset.h
@@ -565,7 +565,7 @@ DAS_API size_t DasDs_memOwned(const DasDs* pThis);
  * 
  * @memberof DasDs
  */
-DAS_API const DasCodec* DasDs_getCodecFor(
+DAS_API DasCodec* DasDs_getCodecFor(
 	const DasDs* pThis, const char* sAryId, int* pItems
 );
 
@@ -614,11 +614,12 @@ DAS_API const DasCodec* DasDs_getCodecFor(
  * 
  * @param nNumItems The number of items to read/write at a time.
  * 
- * @returns DAS_OKAY if the array codec could be defined
+ * @returns NULL if the codec couldn't be defined, or a pointer to
+ *        the new codec otherwise
  * 
  * @memberof DasDs
  */
-DAS_API DasErrCode DasDs_addFixedCodec(
+DAS_API DasCodec* DasDs_addFixedCodec(
 	DasDs* pThis, const char* sAryId, const char* sSemantic, 
 	const char* sEncType, int nItemBytes, int nNumItems
 );
@@ -639,12 +640,12 @@ DAS_API DasErrCode DasDs_addFixedCodec(
  *
  * @param nNumItems The number of items to read/write at a time. 
  * 
- * @returns DAS_OKAY if a new codec could be initialized, a positive error
- *        value otherwies.
+ * @returns NULL if the codec couldn't be defined, or a pointer to
+ *        the new codec otherwise
  * 
  * @memberof DasDs
  */
-DAS_API DasErrCode DasDs_addFixedCodecFrom(
+DAS_API DasCodec* DasDs_addFixedCodecFrom(
 	DasDs* pThis, const char* sAryId, const DasCodec* pOther, int nNumItems
 );
 
@@ -677,11 +678,12 @@ DAS_API DasErrCode DasDs_addFixedCodecFrom(
  * @param pSepByIdx Pointer to an array of separator bytes.  This must
  *        be nSeps * uSepLen long.
  * 
- * @returns DAS_OKAY if the array codec could be defined
+ * @returns NULL if the codec couldn't be defined, or a pointer to
+ *        the new codec otherwise
  * 
  * @memberof DasDs
  */
-DAS_API DasErrCode DasDs_addRaggedCodec(
+DAS_API DasCodec* DasDs_addRaggedCodec(
 	DasDs* pThis, const char* sAryId, const char* sSemantic, 
 	const char* sEncType, int nItemBytes, int nSeps, ubyte uSepLen, const ubyte* pSepByIdx
 );