Internals: Routing recoverable user errors via IMGUI_USER_ERROR() macro. (#1651)
diff --git a/imgui.cpp b/imgui.cpp
index 42b7f45..1706086 100644
--- a/imgui.cpp
+++ b/imgui.cpp
@@ -5820,17 +5820,16 @@
ImGuiWindow* window = g.CurrentWindow;
// Error checking: verify that user hasn't called End() too many times!
- // FIXME-ERRORHANDLING
if (g.CurrentWindowStack.Size <= 1 && g.WithinFrameScopeWithImplicitWindow)
{
- IM_ASSERT(g.CurrentWindowStack.Size > 1 && "Calling End() too many times!");
+ IMGUI_USER_ERROR(g.CurrentWindowStack.Size > 1, "Calling End() too many times!");
return;
}
IM_ASSERT(g.CurrentWindowStack.Size > 0);
// Error checking: verify that user doesn't directly call End() on a child window.
if (window->Flags & ImGuiWindowFlags_ChildWindow)
- IM_ASSERT(g.WithinEndChild && "Must call EndChild() and not End()!");
+ IMGUI_USER_ERROR(g.WithinEndChild, "Must call EndChild() and not End()!");
// Close anything that is open
if (window->DC.CurrentColumns)
@@ -7004,13 +7003,13 @@
{
if (g.CurrentWindowStack.Size > 1)
{
- IM_ASSERT(g.CurrentWindowStack.Size == 1 && "Mismatched Begin/BeginChild vs End/EndChild calls: did you forget to call End/EndChild?");
- while (g.CurrentWindowStack.Size > 1) // FIXME-ERRORHANDLING
+ IMGUI_USER_ERROR(g.CurrentWindowStack.Size == 1, "Mismatched Begin/BeginChild vs End/EndChild calls: did you forget to call End/EndChild?");
+ while (g.CurrentWindowStack.Size > 1)
End();
}
else
{
- IM_ASSERT(g.CurrentWindowStack.Size == 1 && "Mismatched Begin/BeginChild vs End/EndChild calls: did you call End/EndChild too much?");
+ IMGUI_USER_ERROR(g.CurrentWindowStack.Size == 1, "Mismatched Begin/BeginChild vs End/EndChild calls: did you call End/EndChild too much?");
}
}
diff --git a/imgui_internal.h b/imgui_internal.h
index 3b7ad26..f04d4e4 100644
--- a/imgui_internal.h
+++ b/imgui_internal.h
@@ -161,6 +161,11 @@
#define IM_FLOOR(_VAL) ((float)(int)(_VAL)) // ImFloor() is not inlined in MSVC debug builds
#define IM_ROUND(_VAL) ((float)(int)((_VAL) + 0.5f)) //
+// Error handling
+#ifndef IMGUI_USER_ERROR
+#define IMGUI_USER_ERROR(_EXPR, _MSG) IM_ASSERT((_EXPR) && (_MSG)) // Recoverable User Error
+#endif
+
// Debug Logging
#ifndef IMGUI_DEBUG_LOG
#define IMGUI_DEBUG_LOG(_FMT,...) printf("[%05d] " _FMT, GImGui->FrameCount, __VA_ARGS__)
diff --git a/imgui_widgets.cpp b/imgui_widgets.cpp
index 353f97d..beeffba 100644
--- a/imgui_widgets.cpp
+++ b/imgui_widgets.cpp
@@ -6472,8 +6472,8 @@
ImGuiTabBar* tab_bar = g.CurrentTabBar;
if (tab_bar == NULL)
{
- IM_ASSERT(tab_bar != NULL && "Mismatched BeginTabBar()/EndTabBar()!");
- return; // FIXME-ERRORHANDLING
+ IMGUI_USER_ERROR(tab_bar != NULL, "Mismatched BeginTabBar()/EndTabBar()!");
+ return;
}
if (tab_bar->WantLayout)
TabBarLayout(tab_bar);
@@ -6869,8 +6869,8 @@
ImGuiTabBar* tab_bar = g.CurrentTabBar;
if (tab_bar == NULL)
{
- IM_ASSERT(tab_bar && "Needs to be called between BeginTabBar() and EndTabBar()!");
- return false; // FIXME-ERRORHANDLING
+ IMGUI_USER_ERROR(tab_bar, "BeginTabItem() Needs to be called between BeginTabBar() and EndTabBar()!");
+ return false;
}
bool ret = TabItemEx(tab_bar, label, p_open, flags);
if (ret && !(flags & ImGuiTabItemFlags_NoPushId))
