[assert] Add descriptions to debug build as default option

modm-io · Sep 27, 2020 · 6f0c170 · 6f0c170
1 parent d0a6196
commit 6f0c170
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 25 deletions.
diff --git a/src/modm/architecture/interface/assert.h.in b/src/modm/architecture/interface/assert.h.in
@@ -17,15 +17,25 @@
 #include <modm/architecture/utils.hpp>
 
 /// @cond
-#define MODM_ASSERTION_INFO_HAS_DESCRIPTION {{ 1 if options.with_description else 0 }}
+#ifndef MODM_ASSERTION_INFO_HAS_DESCRIPTION
+%% if options.with_description == "debug"
+#ifdef MODM_DEBUG_BUILD
+	#define MODM_ASSERTION_INFO_HAS_DESCRIPTION 1
+#else
+	#define MODM_ASSERTION_INFO_HAS_DESCRIPTION 0
+#endif
+%% else
+#define MODM_ASSERTION_INFO_HAS_DESCRIPTION {{ 1 if options.with_description == "release" else 0 }}
+%% endif
+#endif
 
 // C-type information struct
 typedef struct modm_packed
 {
 	const char *name;
-%% if options.with_description
+#if MODM_ASSERTION_INFO_HAS_DESCRIPTION
 	const char *description;
-%% endif
+#endif
 	uintptr_t context;
 	uint8_t behavior;
 } _modm_assertion_info;
@@ -39,18 +49,32 @@ typedef struct modm_packed
 #define _modm_assert_ifss(s) ((const char *)(s))
 %% endif
 
-#define _modm_assert5(behavior, condition, name, description, context) \
-	({ \
-		const bool evaluated_condition = (bool) (condition); \
-		if (!evaluated_condition) { \
-			_modm_assertion_info info = { \
-				_modm_assert_ifss(name),{% if options.with_description %} _modm_assert_ifss(description),{% endif %} \
-				 (uintptr_t)(context), (uint8_t)(behavior)}; \
-			modm_assert_report(&info); \
-			if (behavior & 4) __builtin_unreachable(); \
-		} \
-		evaluated_condition; \
-	})
+#if MODM_ASSERTION_INFO_HAS_DESCRIPTION
+	#define _modm_assert5(behavior, condition, name, description, context) \
+		({ \
+			const bool evaluated_condition = (bool) (condition); \
+			if (!evaluated_condition) { \
+				_modm_assertion_info info = { \
+					_modm_assert_ifss(name), _modm_assert_ifss(description), \
+					 (uintptr_t)(context), (uint8_t)(behavior)}; \
+				modm_assert_report(&info); \
+				if (behavior & 4) __builtin_unreachable(); \
+			} \
+			evaluated_condition; \
+		})
+#else
+	#define _modm_assert5(behavior, condition, name, description, context) \
+		({ \
+			const bool evaluated_condition = (bool) (condition); \
+			if (!evaluated_condition) { \
+				_modm_assertion_info info = { \
+					_modm_assert_ifss(name), (uintptr_t)(context), (uint8_t)(behavior)}; \
+				modm_assert_report(&info); \
+				if (behavior & 4) __builtin_unreachable(); \
+			} \
+			evaluated_condition; \
+		})
+#endif
 #define _modm_assert4(behavior, condition, name, description) \
 	_modm_assert5(behavior, condition, name, description, -1)
 

diff --git a/src/modm/architecture/interface/assert.hpp.in b/src/modm/architecture/interface/assert.hpp.in
@@ -46,9 +46,9 @@ struct modm_packed
 AssertionInfo
 {
 	const char *name;			///< Can be used to recognise the assertion in code
-%% if options.with_description
+#if MODM_ASSERTION_INFO_HAS_DESCRIPTION
 	const char *description;	///< Detailed failure description
-%% endif
+#endif
 	uintptr_t context;			///< Optional context depends on assertion
 	AbandonmentBehavior behavior;	///< Can this assertion be ignored?
 };
@@ -66,7 +66,7 @@ using AssertionHandler = Abandonment (*)(const AssertionInfo &info);
  *
  * @ingroup modm_architecture_assert
  */
-#define MODM_ASSERTION_INFO_HAS_DESCRIPTION {{ 1 if options.with_description else 0 }}
+#define MODM_ASSERTION_INFO_HAS_DESCRIPTION 0/1
 
 /**
  * This adds a function to the list of assertion handlers to execute on

diff --git a/src/modm/architecture/module.lb b/src/modm/architecture/module.lb
@@ -47,13 +47,15 @@ class Assert(Module):
         module.description = FileReader("interface/assert.md")
 
     def prepare(self, module, options):
+        platform = options[":target"].identifier.platform
         module.add_option(
-            BooleanOption(name="with_description",
-                          default=options[":target"].identifier.platform in ["hosted"],
-                          description=Assert.with_description_descr))
+            EnumerationOption(name="with_description",
+                              description=Assert.with_description_descr,
+                              default="release" if platform == "hosted" else "debug",
+                              enumeration=["off", "debug", "release"]))
 
         module.depends(":architecture:register")
-        if options[":target"].identifier.platform in ["avr"]:
+        if platform == "avr":
             module.depends(":architecture:accessor")
         return True
 

diff --git a/src/modm/board/board.cpp.in b/src/modm/board/board.cpp.in
@@ -35,11 +35,11 @@ modm_abandon(const modm::AssertionInfo &info)
 		MODM_LOG_ERROR << " @ " << (void *) info.context <<
 						 " (" << (uint32_t) info.context << ")";
 	}
-	%% if options.get(":architecture:assert:with_description", False)
+	#if MODM_ASSERTION_INFO_HAS_DESCRIPTION
 	MODM_LOG_ERROR << " failed!\n  " << info.description << "\nAbandoning...\n";
-	%% else
+	#else
 	MODM_LOG_ERROR << " failed!\nAbandoning...\n";
-	%% endif
+	#endif
 %% else
 	(void)info;
 %% endif