pic24_unittest.h File Reference

Go to the source code of this file.

Defines

#define TOSTRING(x)   _TOSTRING(x)
#define _TOSTRING(x)   #x
#define ERROR_FILE_LINE(msg)   "Error in " __FILE__ " line " TOSTRING(__LINE__) ": " msg
#define COMPILE_ASSERT(test, msg)   typedef char _COMPILE_ASSERT_SYMBOL(__LINE__, msg) [ ((test) ? 1 : -1) ]
#define _COMPILE_ASSERT_SYMBOL_INNER(line, msg)   __COMPILE_ASSERT_ ## line ## _____ ## msg
#define _COMPILE_ASSERT_SYMBOL(line, msg)   _COMPILE_ASSERT_SYMBOL_INNER(line, msg)
#define ASSERT(test)   picAssert(test, ERROR_FILE_LINE("ASSERT(" #test ") failed.\n"))

Functions

void reportError (const char *message)
static void picAssert (uint8 test, const char *message)


Detailed Description

Extremely simple unit testing framework, inspired by http://www.jera.com/techinfo/jtns/jtn002.html.

Definition in file pic24_unittest.h.


Define Documentation

#define ASSERT ( test   )     picAssert(test, ERROR_FILE_LINE("ASSERT(" #test ") failed.\n"))

Assert that test is true. See picAssert for details. NOTE: only test results; DO NOT include main-line code in an ASSERT, since it can be compiled out. For example, ASSERT(myFunc()) is dangerous, since myFunc() will no longer be called if ASSERT is disabled by defining _NDEBUG.

Definition at line 93 of file pic24_unittest.h.

#define COMPILE_ASSERT ( test,
msg   )     typedef char _COMPILE_ASSERT_SYMBOL(__LINE__, msg) [ ((test) ? 1 : -1) ]

A useful compile-time assert macro. USAGE: COMPILE_ASSERT( condition, message_to_print_if_fails)

Note: these macros use typedef so they can't be use in a value assignment type macro Note: message_to_print_if_fails is used as C language variable in this clever little macro, SO.... your message must adhere to C variable naming rules, i.e. no spaces or funny characters. Use underscores or CamelCase to separate words.

Definition at line 79 of file pic24_unittest.h.

#define ERROR_FILE_LINE ( msg   )     "Error in " __FILE__ " line " TOSTRING(__LINE__) ": " msg

A macro to add the file name and line at which the macro was called to the given message.

Parameters:
msg Message to add file/line info to.

Definition at line 58 of file pic24_unittest.h.

#define TOSTRING (  )     _TOSTRING(x)

Macro to convert a number to a string. Typical usage: TOSTRING(__LINE__)

Definition at line 49 of file pic24_unittest.h.


Function Documentation

static void picAssert ( uint8  test,
const char *  message 
) [inline, static]

A function to reset the chip and report a message if the test is false. Assumes reportError is called at start-up to report any assertion violations.

Parameters:
test Boolean results of test run. If false, reset and print message.
message Message to print if assertion fails.

Definition at line 104 of file pic24_unittest.h.

void reportError ( const char *  sz_errorMessage  ) 

Report a critical error by recording a message in sz_lastError then resetting the chip, assuming hat printResetCause will be called during chip initialization.

Parameters:
sz_errorMessage Error message to report.
See also:
REPORT_ERROR

Definition at line 167 of file pic24_util.c.


Generated on Mon Oct 18 07:40:48 2010 for Python-on-a-chip by  doxygen 1.5.9