slow_blink 0.0.6 → 0.0.7

data/ext/slow_blink/message/ext_compact_encoder/blink_compact.h

@@ -0,0 +1,411 @@
+/* Copyright (c) 2016 Cameron Harper
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * 
+ * */
+
+#ifndef BLINK_COMPACT_H
+#define BLINK_COMPACT_H
+
+/**
+ * @defgroup blink_compact blink_compact
+ * @ingroup ublink
+ *
+ * Compact form encode/decode functions
+ * 
+ * @{
+ * */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* includes ***********************************************************/
+
+#include <stdint.h>
+#include <stdbool.h>
+
+/* typedefs ***********************************************************/
+
+struct blink_stream;
+
+typedef struct blink_stream * blink_stream_t;
+
+/* functions **********************************************************/
+
+/**
+ * Encode a null
+ *
+ * @param[in] out output stream
+ *
+ * @return null was encoded
+ * @retval true
+ * @retval false
+ * 
+ * */
+bool BLINK_Compact_encodeNull(blink_stream_t out);
+
+/**
+ * Encode a present symbol
+ *
+ * @param[in] out output stream
+ *
+ * @return present was encoded
+ * @retval true
+ * @retval false
+ * 
+ * */
+bool BLINK_Compact_encodePresent(blink_stream_t out);
+
+/**
+ * Decode `bool`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeBool(blink_stream_t in, bool *out, bool *isNull);
+
+/**
+ * Decode `u8`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeU8(blink_stream_t in, uint8_t *out, bool *isNull);
+
+/**
+ * Decode `u16`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeU16(blink_stream_t in, uint16_t *out, bool *isNull);
+
+/**
+ * Decode `u32`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeU32(blink_stream_t in, uint32_t *out, bool *isNull);
+
+/**
+ * Decode `u64`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeU64(blink_stream_t in, uint64_t *out, bool *isNull);
+
+/**
+ * Decode `i8`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeI8(blink_stream_t in, int8_t *out, bool *isNull);
+
+/**
+ * Decode `i16`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeI16(blink_stream_t in, int16_t *out, bool *isNull);
+
+/**
+ * Decode `i32`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeI32(blink_stream_t in, int32_t *out, bool *isNull);
+
+/**
+ * Decode `i64`
+ * 
+ * @param[in] in input stream
+ * @param[out] out decoded value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeI64(blink_stream_t in, int64_t *out, bool *isNull);
+
+/**
+ * Decode `decimal`
+ * 
+ * @param[in] in input stream
+ * @param[out] mantissa decoded mantissa
+ * @param[out] exponent decoded exponent
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeDecimal(blink_stream_t in, int64_t *mantissa, int8_t *exponent, bool *isNull);
+
+/**
+ * Decode `f64`
+ * 
+ * @param[in] in input stream
+ * @param[out] out value
+ * @param[out] isNull set to `true` if `in` decodes to NULL
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_decodeF64(blink_stream_t in, double *out, bool *isNull);
+
+/**
+ * Decode a present field
+ *
+ * @param[in] in input stream
+ * @param[out] out set to `true` if present
+ *
+ * @return value was decoded
+ * @retval true
+ * @retval false
+ * 
+ * */
+bool BLINK_Compact_decodePresent(blink_stream_t in, bool *out);
+
+/**
+ * Encode `bool`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeBool(bool in, blink_stream_t out);
+
+/**
+ * Encode `u8`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeU8(uint8_t in, blink_stream_t out);
+
+/**
+ * Encode `u16`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeU16(uint16_t in, blink_stream_t out);
+
+/**
+ * Encode `u32`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeU32(uint32_t in, blink_stream_t out);
+
+/**
+ * Encode `u64`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeU64(uint64_t in, blink_stream_t out);
+
+/**
+ * Encode `i8`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeI8(int8_t in, blink_stream_t out);
+
+/**
+ * Encode `i16`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeI16(int16_t in, blink_stream_t out);
+
+/**
+ * Encode `i32`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeI32(int32_t in, blink_stream_t out);
+
+/**
+ * Encode `i64`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeI64(int64_t in, blink_stream_t out);
+
+/**
+ * Encode `f64`
+ *
+ * @param[in] in input value
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeF64(double in, blink_stream_t out);
+
+/**
+ * Encode `decimal`
+ *
+ * @param[in] mantissa
+ * @param[in] exponent
+ * @param[in] out output stream
+ *
+ * @return value was encoded
+ * @retval true
+ * @retval false
+ *
+ * */
+bool BLINK_Compact_encodeDecimal(int64_t mantissa, int8_t exponent, blink_stream_t out);
+
+/**
+ * Calculate encoded size of unsigned integer
+ *
+ * @param[in] value unsigned integer
+ * @return encoded size in bytes
+ *
+ * */
+uint8_t BLINK_Compact_sizeofUnsigned(uint64_t value);
+
+/**
+ * Calculate encoded size of signed integer
+ *
+ * @param[in] value signed integer
+ * @return encoded size in bytes
+ *
+ * */
+uint8_t BLINK_Compact_sizeofSigned(int64_t value);
+ 
+#ifdef __cplusplus
+}
+#endif
+
+/** @} */
+#endif

data/ext/slow_blink/message/ext_compact_encoder/blink_debug.h

@@ -0,0 +1,46 @@
+/* Copyright (c) 2016 Cameron Harper
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * 
+ * */
+#ifndef BLINK_DEBUG_H
+#define BLINK_DEBUG_H
+
+#ifdef NDEBUG
+
+    #define BLINK_ERROR(...) /* BLINK_ERROR(...) */
+
+    #define BLINK_DEBUG(...)  /* BLINK_DEBUG(...) */
+
+    #define BLINK_ASSERT(X) /* BLINK_ASSERT(X) */
+
+#else
+
+    #include <assert.h>
+    #include <stdio.h>
+
+    #define BLINK_ERROR(...)  do{fprintf(stderr, __VA_ARGS__);fprintf(stderr, "\n");}while(0);
+
+    #define BLINK_DEBUG(...)  do{fprintf(stdout, "%s: ", __FUNCTION__);fprintf(stdout, __VA_ARGS__);fprintf(stdout, "\n");}while(0);
+
+    #define BLINK_ASSERT(X)   assert((X));
+    
+#endif
+
+#endif