%% options copyright owner = Dirk Krause copyright year = 2016-xxxx license = bsd %% header /** @file dk4strms.h Serialize data to a stream. The functions to serialize integers write the least significant byte first. When serializing a string, the string length is serialized first as 16 bit unsigned number, string contents follows. The finalizing 0x00 byte is both counted in the string length and written to the stream. So a reader application can retrieve the length first, allocate a memory block of exact size and read the string. Reader applications should check/ensure the finalizing byte after reading string contents. When serializing a double, the double is converted to a string and the string is serialized to the stream. For 0.0 and values nearby (absolute value is below a given limit) a string length 0 is serialized to the stream instead, no string is written. */ #ifndef DK4CONF_H_INCLUDED #include "dk4conf.h" #endif #ifndef DK4TYPES_H_INCLUDED #include "dk4types.h" #endif #ifndef DK4ERROR_H_INCLUDED #include "dk4error.h" #endif #ifndef DK4STRM_H_INCLUDED #include #endif #ifdef __cplusplus extern "C" { #endif /** Serialize unsigned 32 bit integer to stream. @param strm Destination stream. @param u32 Value to serialize. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_u32(dk4_stream_t *strm, uint32_t u32, dk4_er_t *erp); /** Serialize signed 32 bit integer to stream. @param strm Destination stream. @param i32 Value to serialize. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_i32(dk4_stream_t *strm, int32_t i32, dk4_er_t *erp); /** Serialize unsigned 16 bit integer to stream. @param strm Destination stream. @param u16 Value to serialize. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_u16(dk4_stream_t *strm, uint16_t u16, dk4_er_t *erp); /** Serialize signed 16 bit integer to stream. @param strm Destination stream. @param i16 Value to serialize. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_i16(dk4_stream_t *strm, int16_t i16, dk4_er_t *erp); /** Serialize unsigned 8 bit integer to stream. @param strm Destination stream. @param u8 Value to serialize. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_u8(dk4_stream_t *strm, uint8_t u8, dk4_er_t *erp); /** Serialize signed 8 bit integer to stream. @param strm Destination stream. @param i8 Value to serialize. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_i8(dk4_stream_t *strm, int8_t i8, dk4_er_t *erp); /** Serialize string to stream. First the string length including the 0x00 finalizer byte is written as 16 bit unsigned integer, the string including the finalizer byte follows. By reading the length first, a reader application can allocate a memory block of exact size before reading the string contents. @param strm Destination stream. @param str String to serialize, max 65534 characters long. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if strm is NULL or not opened for writing, - DK4_E_BUFFER_TOO_SMALL
if the str string is too long, - DK4_E_WRITE_FAILED
if writing one ore multiple bytes to the stream failed, - DK4_E_FLUSH_FAILED
if flusing data downwards failed. */ int dk4stream_serialize_string(dk4_stream_t *strm, const char *str, dk4_er_t *erp); /** Serialize floating point value to stream. For non-0.0 values the value is converted to a string, the string is serialized to the stream. For 0.0 and values near enough (absolute value is below a given limit) a string length 0 is written indicating the 0.0 value to reader applications. @param strm Destination stream. @param d Value to serialize. @param e Epsilon for check whether d is 0. @param erp Error report, may be NULL. @return 1 on success, 0 on error. */ int dk4stream_serialize_double(dk4_stream_t *strm,double d,double e,dk4_er_t *erp); /** Serialize floating point value 0 in short form. @param strm Stream to write to. @param erp Error report, may be NULL. */ int dk4stream_serialize_double_0(dk4_stream_t *strm, dk4_er_t *erp); #ifdef __cplusplus } #endif /* vim: set ai sw=4 ts=4 : */ %% module #include "dk4conf.h" #if DK4_HAVE_STRING_H #ifndef STRING_H_INCLUDED #include #define STRING_H_INCLUDED 1 #endif #endif #if DK4_HAVE_MATH_H #ifndef MATH_H_INCLUDED #include #define MATH_H_INCLUDED 1 #endif #endif #include "dk4strms.h" #include "dk4mao8dbl.h" int dk4stream_serialize_u32(dk4_stream_t *strm, uint32_t u32, dk4_er_t *erp) { unsigned char buf[8]; int back = 0; if (NULL != strm) { buf[0] = (unsigned char)( u32 & 0x000000FFUL); buf[1] = (unsigned char)((u32 >> 8) & 0x000000FFUL); buf[2] = (unsigned char)((u32 >> 16) & 0x000000FFUL); buf[3] = (unsigned char)((u32 >> 24) & 0x000000FFUL); back = dk4stream_write(strm, buf, 4, erp); } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } int dk4stream_serialize_i32(dk4_stream_t *strm, int32_t i32, dk4_er_t *erp) { return ( dk4stream_serialize_u32(strm, (uint32_t)i32, erp) ); } int dk4stream_serialize_u16(dk4_stream_t *strm, uint16_t u16, dk4_er_t *erp) { unsigned char buf[8]; int back = 0; if (NULL != strm) { buf[0] = (unsigned char)( u16 & 0x00FFU); buf[1] = (unsigned char)((u16 >> 8) & 0x00FFU); back = dk4stream_write(strm, buf, 2, erp); } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } int dk4stream_serialize_i16(dk4_stream_t *strm, int16_t i16, dk4_er_t *erp) { return ( dk4stream_serialize_u16(strm, (uint16_t)i16, erp) ); } int dk4stream_serialize_u8(dk4_stream_t *strm, uint8_t u8, dk4_er_t *erp) { unsigned char uc; int back = 0; if (NULL != strm) { uc = (unsigned char)u8; back = dk4stream_write(strm, &uc, 1, erp); } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } int dk4stream_serialize_i8(dk4_stream_t *strm, int8_t i8, dk4_er_t *erp) { return ( dk4stream_serialize_u8(strm, (uint8_t)i8, erp) ); } int dk4stream_serialize_string(dk4_stream_t *strm, const char *str, dk4_er_t *erp) { size_t sl = 0; int back = 0; if ((NULL != strm) && (NULL != str)) { sl = strlen(str); if (((size_t)0xFFFFU) > sl) { sl++; if (0 < dk4stream_serialize_u16(strm, (uint16_t)sl, erp)) { back = dk4stream_write(strm, str, sl, erp); } else { /* ERROR: Failed to serialize string length already reported */ } } else { dk4error_set_simple_error_code(erp, DK4_E_BUFFER_TOO_SMALL); } } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } int dk4stream_serialize_double(dk4_stream_t *strm,double d,double e,dk4_er_t *erp) { char buf[16*sizeof(double)]; size_t szbuf = sizeof(buf); int back = 0; if (NULL != strm) { if (fabs(d) < e) { back = dk4stream_serialize_u16(strm, (uint16_t)0U, erp); } else { if (0 < dk4ma_write_c8_double(buf, szbuf, d, 1, 1, erp)) { back = dk4stream_serialize_string(strm, buf, erp); } else { /* ##### ERROR: Failed to write double to string */ } } } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } int dk4stream_serialize_double_0(dk4_stream_t *strm, dk4_er_t *erp) { int back = 0; if (NULL != strm) { back = dk4stream_serialize_u16(strm, 0U, erp); } else { dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS); } return back; } /* vim: set ai sw=4 ts=4 : */