Reformat all codal-core source files

inc/core/CodalAssert.h

@@ -27,7 +27,7 @@ DEALINGS IN THE SOFTWARE.
 
 /**
  * Intended for use in test suites - should not be used in production code!
- * 
+ *
  * (although they will compile to nothing if assertions are disabled...)
  */
 
@@ -39,19 +39,19 @@ DEALINGS IN THE SOFTWARE.
 #endif
 
 #if CONFIG_ENABLED(CODAL_ENABLE_ASSERT)
-    void __codal_assert__( const char * file, const int line, bool condition, const char * expr, const char * message );
-    void __codal_fault__( const char * file, const int line, const char * message  );
-    void __codal_assert_pass__( const char * file, const int line, const char * message );
-    void __codal_assert_fail__( const char * file, const int line, const char * message );
-    #define assert(condition, message) __codal_assert__( __FILENAME__, __LINE__, (condition) == true, #condition, message )
-    #define assert_fault(message) __codal_fault__( __FILENAME__, __LINE__, message )
-    #define assert_pass(message) __codal_assert_pass__( __FILENAME__, __LINE__, message )
-    #define assert_fail(message) __codal_assert_fail__( __FILENAME__, __LINE__, message )
+void __codal_assert__(const char* file, const int line, bool condition, const char* expr, const char* message);
+void __codal_fault__(const char* file, const int line, const char* message);
+void __codal_assert_pass__(const char* file, const int line, const char* message);
+void __codal_assert_fail__(const char* file, const int line, const char* message);
+#define assert(condition, message) __codal_assert__(__FILENAME__, __LINE__, (condition) == true, #condition, message)
+#define assert_fault(message)      __codal_fault__(__FILENAME__, __LINE__, message)
+#define assert_pass(message)       __codal_assert_pass__(__FILENAME__, __LINE__, message)
+#define assert_fail(message)       __codal_assert_fail__(__FILENAME__, __LINE__, message)
 #else
-    #define assert(x,y)
-    #define assert_fault(message)
-    #define assert_pass(message)
-    #define assert_fail(message)
+#define assert(x, y)
+#define assert_fault(message)
+#define assert_pass(message)
+#define assert_fail(message)
 #endif
 
 #endif

inc/core/CodalCompat.h

@@ -23,9 +23,9 @@ DEALINGS IN THE SOFTWARE.
 */
 
 /**
-  * This file contains functions used to maintain compatability and portability.
-  * It also contains constants that are used elsewhere in the DAL.
-  */
+ * This file contains functions used to maintain compatability and portability.
+ * It also contains constants that are used elsewhere in the DAL.
+ */
 
 #ifndef DEVICE_COMPAT_H
 #define DEVICE_COMPAT_H
@@ -40,123 +40,122 @@ DEALINGS IN THE SOFTWARE.
 #undef min
 #undef max
 
-namespace codal
+namespace codal {
+/**
+ * Determines the smallest of the two numbers
+ *
+ * @param a the first number
+ *
+ * @param b the second number
+ *
+ * @return The smallest of the two given values.
+ */
+inline int min(int a, int b)
+{
+    return (a < b ? a : b);
+}
+
+/**
+ * Determines the largest of the two numbers
+ *
+ * @param a the first number
+ *
+ * @param b the second number
+ *
+ * @return The larger of the two given values.
+ */
+inline int max(int a, int b)
 {
-    /**
-      * Determines the smallest of the two numbers
-      *
-      * @param a the first number
-      *
-      * @param b the second number
-      *
-      * @return The smallest of the two given values.
-      */
-    inline int min(int a, int b)
-    {
-        return (a < b ? a : b);
-    }
-
-    /**
-      * Determines the largest of the two numbers
-      *
-      * @param a the first number
-      *
-      * @param b the second number
-      *
-      * @return The larger of the two given values.
-      */
-    inline int max(int a, int b)
-    {
-        return (a > b ? a : b);
-    }
-
-    /**
-      * Sets a given area of memory to zero.
-      *
-      * @param a the pointer to the beginning of the memory to clear
-      *
-      * @param b the number of bytes to clear.
-      */
-    inline void *memclr(void *a, size_t b)
-    {
-        return memset(a,0,b);
-    }
-
-    /**
-      * Determines if the given character is a printable ASCII/UTF8 decimal digit (0..9).
-      *
-      * @param c the character to check
-      *
-      * @return true if the character is a digit, false otherwise.
-      */
-    inline bool isdigit(char c)
-    {
-        return (c > 47 && c < 58);
-    }
-
-    /**
-      * Extracts the upper 8 bits of a 16 bit integer
-      *
-      * @param val the 16 bit value.
-      *
-      * @return the upper 8 bits of the given val.
-      */
-    inline uint8_t high(uint16_t val)
-    {
-        return val >> 8;
-    }
-
-    /**
-      * Extracts the lower 8 bits of a 16 bit integer
-      *
-      * @param val the 16 bit value.
-      *
-      * @return the lower 8 bits of the given val.
-      */
-    inline uint8_t low(uint16_t val)
-    {
-        return val & 0xFF;
-    }
-
-    /**
-      * Performs an in buffer reverse of a given char array.
-      *
-      * @param s the string to reverse.
-      *
-      * @return DEVICE_OK, or DEVICE_INVALID_PARAMETER.
-      */
-    int string_reverse(char *s);
-
-    /**
-      * Converts a given integer into a string representation.
-      *
-      * @param n The number to convert.
-      *
-      * @param s A pointer to the buffer where the resulting string will be stored.
-      *
-      * @return DEVICE_OK, or DEVICE_INVALID_PARAMETER.
-      */
-    int itoa(int n, char *s);
-
-    /**
-     * Seed the random number generator (RNG).
-     *
-     * @param seed an unsigned 32 bit value used to seed codal's lightweight Galois LFSR.
-     * @return DEVICE_OK on success
-     */
-    int seed_random(uint32_t random);
-
-    /**
-     * Generate a random number in the given range.
-     * default: A simple Galois LFSR random number generator.
-     * A well seeded Galois LFSR is sufficient for most applications, and much more lightweight
-     * than hardware random number generators often built int processor, which takes
-     * a long time and uses a lot of energy.
-     *
-     * @param max the upper range to generate a number for. This number cannot be negative.
-     * @return A random, natural number between 0 and the max-1. Or DEVICE_INVALID_VALUE if max is <= 0.
-     */
-    int random(int max);
+    return (a > b ? a : b);
 }
 
+/**
+ * Sets a given area of memory to zero.
+ *
+ * @param a the pointer to the beginning of the memory to clear
+ *
+ * @param b the number of bytes to clear.
+ */
+inline void* memclr(void* a, size_t b)
+{
+    return memset(a, 0, b);
+}
+
+/**
+ * Determines if the given character is a printable ASCII/UTF8 decimal digit (0..9).
+ *
+ * @param c the character to check
+ *
+ * @return true if the character is a digit, false otherwise.
+ */
+inline bool isdigit(char c)
+{
+    return (c > 47 && c < 58);
+}
+
+/**
+ * Extracts the upper 8 bits of a 16 bit integer
+ *
+ * @param val the 16 bit value.
+ *
+ * @return the upper 8 bits of the given val.
+ */
+inline uint8_t high(uint16_t val)
+{
+    return val >> 8;
+}
+
+/**
+ * Extracts the lower 8 bits of a 16 bit integer
+ *
+ * @param val the 16 bit value.
+ *
+ * @return the lower 8 bits of the given val.
+ */
+inline uint8_t low(uint16_t val)
+{
+    return val & 0xFF;
+}
+
+/**
+ * Performs an in buffer reverse of a given char array.
+ *
+ * @param s the string to reverse.
+ *
+ * @return DEVICE_OK, or DEVICE_INVALID_PARAMETER.
+ */
+int string_reverse(char* s);
+
+/**
+ * Converts a given integer into a string representation.
+ *
+ * @param n The number to convert.
+ *
+ * @param s A pointer to the buffer where the resulting string will be stored.
+ *
+ * @return DEVICE_OK, or DEVICE_INVALID_PARAMETER.
+ */
+int itoa(int n, char* s);
+
+/**
+ * Seed the random number generator (RNG).
+ *
+ * @param seed an unsigned 32 bit value used to seed codal's lightweight Galois LFSR.
+ * @return DEVICE_OK on success
+ */
+int seed_random(uint32_t random);
+
+/**
+ * Generate a random number in the given range.
+ * default: A simple Galois LFSR random number generator.
+ * A well seeded Galois LFSR is sufficient for most applications, and much more lightweight
+ * than hardware random number generators often built int processor, which takes
+ * a long time and uses a lot of energy.
+ *
+ * @param max the upper range to generate a number for. This number cannot be negative.
+ * @return A random, natural number between 0 and the max-1. Or DEVICE_INVALID_VALUE if max is <= 0.
+ */
+int random(int max);
+}  // namespace codal
+
 #endif