libfsafe/assert.hxx

   1 /**
   2  * @file
   3  *
   4  * Contains declarations of assertion macros.
   5  */
   6
   7 #ifndef LIBFSAFE_ASSERT_HXX
   8 #define LIBFSAFE_ASSERT_HXX
   9
  10 #include <libsex/utility.hxx>
  11 #include <libfsafe/AssertionFailure.hxx>
  12 #include <libfsafe/PreconditionViolation.hxx>
  13 #include <libfsafe/PostconditionViolation.hxx>
  14
  15 /**
  16  * General assertion macro.
  17  *
  18  * There are assertion macros for specific purposes.
  19  * This one should only be used for internal checks.
  20  *
  21  * @param expr Condition to be asserted.
  22  * @throws libfsafe::AssertionFailure if @a expr is false.
  23  * @see ASSERT_PRE
  24  * @see ASSERT_POST
  25  */
  26 #define ASSERT(expr) \
  27 if (!(expr)) { \
  28         throw libsex::formatted<libfsafe::AssertionFailure>(__FILE__, __LINE__, #expr); \
  29 }
  30
  31 /**
  32  * Macro to assert a precondition.
  33  *
  34  * To be used to ensure that a method/function is called
  35  * the right way (e.g. parameter values, internal state).
  36  *
  37  * In other words, assert that the callee fulfilled its
  38  * part of the contract.
  39  *
  40  * @param expr Condition to be asserted.
  41  * @throws libfsafe::PreconditionViolation if @a expr is false.
  42  * @see ASSERT
  43  * @see ASSERT_POST
  44  */
  45 #define ASSERT_PRE(expr) \
  46 if (!(expr)) { \
  47         throw libsex::formatted<libfsafe::PreconditionViolation>(__FILE__, __LINE__, #expr); \
  48 }
  49
  50 /**
  51  * Macro to assert a postcondition.
  52  *
  53  * To be used to ensure that the result of a
  54  * function/method is correct, i.e. the callee fulfilled
  55  * its part of the contract.
  56  *
  57  * @param expr Condition to be asserted.
  58  * @throws libfsafe::PostconditionViolation if @a expr is false.
  59  * @see ASSERT_PRE
  60  * @see ASSERT
  61  */
  62 #define ASSERT_POST(expr) \
  63 if (!(expr)) { \
  64         throw libsex::formatted<libfsafe::PostconditionViolation>(__FILE__, __LINE__, #expr); \
  65 }
  66
  67 #endif