Add format args to dbg_assert

Author: ChillerDragon

src/base/system.cpp

@@ -127,24 +127,26 @@ bool dbg_assert_has_failed()
 	return dbg_assert_failing.load(std::memory_order_acquire);
 }
 
-void dbg_assert_imp(const char *filename, int line, bool test, const char *msg)
+void dbg_assert_imp(const char *filename, int line, const char *fmt, ...)
 {
-	if(!test)
+	const bool already_failing = dbg_assert_has_failed();
+	dbg_assert_failing.store(true, std::memory_order_release);
+	char msg[512];
+	va_list args;
+	va_start(args, fmt);
+	str_format_v(msg, sizeof(msg), fmt, args);
+	char error[512];
+	str_format(error, sizeof(error), "%s(%d): %s", filename, line, msg);
+	va_end(args);
+	log_error("assert", "%s", error);
+	if(!already_failing)
 	{
-		const bool already_failing = dbg_assert_has_failed();
-		dbg_assert_failing.store(true, std::memory_order_release);
-		char error[512];
-		str_format(error, sizeof(error), "%s(%d): %s", filename, line, msg);
-		dbg_msg("assert", "%s", error);
-		if(!already_failing)
-		{
-			DBG_ASSERT_HANDLER handler = dbg_assert_handler;
-			if(handler)
-				handler(error);
-		}
-		log_global_logger_finish();
-		dbg_break();
+		DBG_ASSERT_HANDLER handler = dbg_assert_handler;
+		if(handler)
+			handler(error);
 	}
+	log_global_logger_finish();
+	dbg_break();
 }
 
 void dbg_break()
@@ -911,12 +913,7 @@ void sphore_init(SEMAPHORE *sem)
 	char aBuf[64];
 	str_format(aBuf, sizeof(aBuf), "/%d.%p", pid(), (void *)sem);
 	*sem = sem_open(aBuf, O_CREAT | O_EXCL, S_IRWXU | S_IRWXG, 0);
-	if(*sem == SEM_FAILED)
-	{
-		char aError[128];
-		str_format(aError, sizeof(aError), "sem_open failure, errno=%d, name='%s'", errno, aBuf);
-		dbg_assert(false, aError);
-	}
+	dbg_assert(*sem != SEM_FAILED, "sem_open failure, errno=%d, name='%s'", errno, aBuf);
 }
 void sphore_wait(SEMAPHORE *sem)
 {

src/base/system.h

@@ -55,6 +55,12 @@
 #define MAYBE_UNUSED
 #endif
 
+#ifdef __GNUC__
+#define GNUC_ATTRIBUTE(x) __attribute__(x)
+#else
+#define GNUC_ATTRIBUTE(x)
+#endif
+
 /**
  * @defgroup Debug
  *
@@ -73,19 +79,31 @@
  *
  * @see dbg_break
  */
-#define dbg_assert(test, msg) dbg_assert_imp(__FILE__, __LINE__, test, msg)
-void dbg_assert_imp(const char *filename, int line, bool test, const char *msg);
+#define dbg_assert(test, fmt, ...) \
+	do \
+	{ \
+		if(!(test)) \
+		{ \
+			dbg_assert_imp(__FILE__, __LINE__, fmt, ##__VA_ARGS__); \
+		} \
+	} while(false)
+
+/**
+ * Use dbg_assert instead!
+ *
+ * @ingroup Debug
+ */
+#if defined(__cplusplus)
+[[noreturn]]
+#endif
+void
+dbg_assert_imp(const char *filename, int line, const char *fmt, ...)
+	GNUC_ATTRIBUTE((format(printf, 3, 4)));
 
 #ifdef __clang_analyzer__
 #include <cassert>
 #undef dbg_assert
-#define dbg_assert(test, msg) assert(test)
-#endif
-
-#ifdef __GNUC__
-#define GNUC_ATTRIBUTE(x) __attribute__(x)
-#else
-#define GNUC_ATTRIBUTE(x)
+#define dbg_assert(test, fmt, ...) assert(test)
 #endif
 
 /**

src/engine/client/graphics_threaded.cpp

@@ -1893,12 +1893,7 @@ void *CGraphics_Threaded::AllocCommandBufferData(size_t AllocSize)
 		KickCommandBuffer();
 
 		pData = m_pCommandBuffer->AllocData(AllocSize);
-		if(pData == nullptr)
-		{
-			char aError[256];
-			str_format(aError, sizeof(aError), "graphics: failed to allocate data (size %" PRIzu ") for command buffer", AllocSize);
-			dbg_assert(false, aError);
-		}
+		dbg_assert(pData, "graphics: failed to allocate data (size %" PRIzu ") for command buffer", AllocSize);
 	}
 	return pData;
 }

src/engine/client/graphics_threaded.h

@@ -890,19 +890,8 @@ class CGraphics_Threaded : public IEngineGraphics
 		// kick command buffer and try again
 		KickCommandBuffer();
 
-		if(!FailFunc())
-		{
-			char aError[256];
-			str_format(aError, sizeof(aError), "graphics: failed to run fail handler for command '%s'", typeid(TName).name());
-			dbg_assert(false, aError);
-		}
-
-		if(!m_pCommandBuffer->AddCommandUnsafe(Cmd))
-		{
-			char aError[256];
-			str_format(aError, sizeof(aError), "graphics: failed to add command '%s' to command buffer", typeid(TName).name());
-			dbg_assert(false, aError);
-		}
+		dbg_assert(FailFunc(), "graphics: failed to run fail handler for command '%s'", typeid(TName).name());
+		dbg_assert(m_pCommandBuffer->AddCommandUnsafe(Cmd), "graphics: failed to add command '%s' to command buffer", typeid(TName).name());
 	}
 
 	void KickCommandBuffer();

src/engine/client/input.cpp

@@ -32,19 +32,9 @@
 #undef KeyPress // Undo pollution from X11/Xlib.h included by SDL_syswm.h on Linux
 #endif
 
-static void AssertKeyValid(int Key)
-{
-	if(Key < KEY_FIRST || Key >= KEY_LAST)
-	{
-		char aError[32];
-		str_format(aError, sizeof(aError), "Key invalid: %d", Key);
-		dbg_assert(false, aError);
-	}
-}
-
 void CInput::AddKeyEvent(int Key, int Flags)
 {
-	AssertKeyValid(Key);
+	dbg_assert(Key >= KEY_FIRST && Key < KEY_LAST, "Key invalid: %d", Key);
 	dbg_assert((Flags & (FLAG_PRESS | FLAG_RELEASE)) != 0 && (Flags & ~(FLAG_PRESS | FLAG_RELEASE)) == 0, "Flags invalid");
 
 	CEvent Event;
@@ -386,19 +376,19 @@ float CInput::GetUpdateTime() const
 
 bool CInput::KeyIsPressed(int Key) const
 {
-	AssertKeyValid(Key);
+	dbg_assert(Key >= KEY_FIRST && Key < KEY_LAST, "Key invalid: %d", Key);
 	return m_aCurrentKeyStates[Key];
 }
 
 bool CInput::KeyPress(int Key) const
 {
-	AssertKeyValid(Key);
+	dbg_assert(Key >= KEY_FIRST && Key < KEY_LAST, "Key invalid: %d", Key);
 	return m_aFrameKeyStates[Key];
 }
 
 const char *CInput::KeyName(int Key) const
 {
-	AssertKeyValid(Key);
+	dbg_assert(Key >= KEY_FIRST && Key < KEY_LAST, "Key invalid: %d", Key);
 	return g_aaKeyStrings[Key];
 }
 

src/engine/client/sound.cpp

@@ -285,13 +285,10 @@ CSample *CSound::AllocSample()
 		return nullptr;
 
 	CSample *pSample = &m_aSamples[m_FirstFreeSampleIndex];
-	if(pSample->m_pData != nullptr || pSample->m_NextFreeSampleIndex == SAMPLE_INDEX_USED)
-	{
-		char aError[128];
-		str_format(aError, sizeof(aError), "Sample was not unloaded (index=%d, next=%d, duration=%f, data=%p)",
-			pSample->m_Index, pSample->m_NextFreeSampleIndex, pSample->TotalTime(), pSample->m_pData);
-		dbg_assert(false, aError);
-	}
+	dbg_assert(
+		pSample->m_pData && pSample->m_NextFreeSampleIndex != SAMPLE_INDEX_USED,
+		"Sample was not unloaded (index=%d, next=%d, duration=%f, data=%p)",
+		pSample->m_Index, pSample->m_NextFreeSampleIndex, pSample->TotalTime(), pSample->m_pData);
 	m_FirstFreeSampleIndex = pSample->m_NextFreeSampleIndex;
 	pSample->m_NextFreeSampleIndex = SAMPLE_INDEX_USED;
 	return pSample;

src/engine/shared/config.cpp

@@ -361,9 +361,7 @@ void CConfigManager::SetReadOnly(const char *pScriptName, bool ReadOnly)
 			return;
 		}
 	}
-	char aBuf[IConsole::CMDLINE_LENGTH + 32];
-	str_format(aBuf, sizeof(aBuf), "Invalid command for SetReadOnly: '%s'", pScriptName);
-	dbg_assert(false, aBuf);
+	dbg_assert(false, "Invalid command for SetReadOnly: '%s'", pScriptName);
 }
 
 bool CConfigManager::Save()

src/engine/shared/datafile.cpp

@@ -781,12 +781,7 @@ void CDataFileWriter::Finish()
 		DataInfo.m_CompressedSize = CompressedSize;
 		free(DataInfo.m_pUncompressedData);
 		DataInfo.m_pUncompressedData = nullptr;
-		if(Result != Z_OK)
-		{
-			char aError[32];
-			str_format(aError, sizeof(aError), "zlib compression error %d", Result);
-			dbg_assert(false, aError);
-		}
+		dbg_assert(Result == Z_OK, "zlib compression error %d", Result);
 	}
 
 	// Calculate total size of items

src/engine/shared/network_server.cpp

@@ -732,8 +732,10 @@ int CNetServer::Send(CNetChunk *pChunk)
 	else
 	{
 		int Flags = 0;
-		dbg_assert(pChunk->m_ClientId >= 0, "erroneous client id");
-		dbg_assert(pChunk->m_ClientId < MaxClients(), "erroneous client id");
+		dbg_assert(
+			pChunk->m_ClientId >= 0 && pChunk->m_ClientId < MaxClients(),
+			"erroneous client id %d",
+			pChunk->m_ClientId);
 
 		if(pChunk->m_Flags & NETSENDFLAG_VITAL)
 			Flags = NET_CHUNKFLAG_VITAL;