1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
#pragma once
// The MIT License (MIT)
//
// Copyright (c) 2021 Frank D. Martinez M. <aka mnesarco>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
#include <imgui.h>
// clang-format off
// ----------------------------------------------------------------------------
// [SECTION] RAII guard implementations
// ----------------------------------------------------------------------------
namespace ImGuiSugar
{
using ScopeEndCallback = void(*)();
// RAII scope guard for ImGui Begin* functions returning bool.
template<bool AlwaysCallEnd>
struct BooleanGuard
{
BooleanGuard(const bool state, const ScopeEndCallback end) noexcept
: m_state(state), m_end(end) {}
BooleanGuard(const BooleanGuard<AlwaysCallEnd>&) = delete;
BooleanGuard(BooleanGuard<AlwaysCallEnd>&&) = delete;
BooleanGuard<AlwaysCallEnd>& operator=(const BooleanGuard<AlwaysCallEnd>&) = delete; // NOLINT
BooleanGuard<AlwaysCallEnd>& operator=(BooleanGuard<AlwaysCallEnd>&&) = delete; // NOLINT
~BooleanGuard() noexcept
{
if (AlwaysCallEnd || m_state) { m_end(); }
}
operator bool() const & noexcept { return m_state; } // (Implicit) NOLINT
private:
const bool m_state;
const ScopeEndCallback m_end;
};
// For special cases, transform void(*)(int) to void(*)()
inline void PopStyleColor() { ImGui::PopStyleColor(1); };
inline void PopStyleVar() { ImGui::PopStyleVar(1); };
// Tooltip auto triggered on hover
inline auto BeginTooltip() -> bool
{
if (ImGui::IsItemHovered())
{
ImGui::BeginTooltip();
return true;
}
return false;
}
} // namespace ImGuiSugar
// ----------------------------------------------------------------------------
// [SECTION] Utility macros
// ----------------------------------------------------------------------------
// Portable Expression Statement, calls void function and returns true
#define IMGUI_SUGAR_ES(FN, ...) ([&]() -> bool { FN(__VA_ARGS__); return true; }())
#define IMGUI_SUGAR_ES_0(FN) ([&]() -> bool { FN(); return true; }())
// Concatenating symbols with __LINE__ requires two levels of indirection
#define IMGUI_SUGAR_CONCAT0(A, B) A ## B
#define IMGUI_SUGAR_CONCAT1(A, B) IMGUI_SUGAR_CONCAT0(A, B)
// ----------------------------------------------------------------------------
// [SECTION] Generic macros to simplify repetitive declarations
// ----------------------------------------------------------------------------
//
// +----------------------+-------------------+-----------------+---------------------+
// | BEGIN | END | ALWAYS | __VA_ARGS__ |
// +----------------------+-------------------+-----------------+---------------------+
// | Begin*/Push* | End*/Pop* | Is call to END | Begin*/Push* |
// | function name | function name | unconditional? | function arguments |
// +----------------------+-------------------+-----------------+---------------------+
#define IMGUI_SUGAR_SCOPED_BOOL(BEGIN, END, ALWAYS, ...) \
if (const ImGuiSugar::BooleanGuard<ALWAYS> _ui_scope_guard = {BEGIN(__VA_ARGS__), &END})
#define IMGUI_SUGAR_SCOPED_BOOL_0(BEGIN, END, ALWAYS) \
if (const ImGuiSugar::BooleanGuard<ALWAYS> _ui_scope_guard = {BEGIN(), &END})
#define IMGUI_SUGAR_SCOPED_VOID_N(BEGIN, END, ...) \
if (const ImGuiSugar::BooleanGuard<true> _ui_scope_guard = {IMGUI_SUGAR_ES(BEGIN, __VA_ARGS__), &END})
#define IMGUI_SUGAR_SCOPED_VOID_0(BEGIN, END) \
if (const ImGuiSugar::BooleanGuard<true> _ui_scope_guard = {IMGUI_SUGAR_ES_0(BEGIN), &END})
#define IMGUI_SUGAR_PARENT_SCOPED_VOID_N(BEGIN, END, ...) \
const ImGuiSugar::BooleanGuard<true> IMGUI_SUGAR_CONCAT1(_ui_scope_, __LINE__) = {IMGUI_SUGAR_ES(BEGIN, __VA_ARGS__), &END}
// ---------------------------------------------------------------------------
// [SECTION] ImGui DSL
// ----------------------------------------------------------------------------
// Self scoped blocks
#define with_Window(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::Begin, ImGui::End, true, __VA_ARGS__)
#define with_Child(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginChild, ImGui::EndChild, true, __VA_ARGS__)
#define with_ChildFrame(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginChildFrame, ImGui::EndChildFrame, true, __VA_ARGS__)
#define with_Combo(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginCombo, ImGui::EndCombo, false, __VA_ARGS__)
#define with_ListBox(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginListBox, ImGui::EndListBox, false, __VA_ARGS__)
#define with_Menu(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginMenu, ImGui::EndMenu, false, __VA_ARGS__)
#define with_Popup(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginPopup, ImGui::EndPopup, false, __VA_ARGS__)
#define with_PopupModal(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginPopupModal, ImGui::EndPopup, false, __VA_ARGS__)
#define with_PopupContextItem(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginPopupContextItem, ImGui::EndPopup, false, __VA_ARGS__)
#define with_PopupContextWindow(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginPopupContextWindow, ImGui::EndPopup, false, __VA_ARGS__)
#define with_PopupContextVoid(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginPopupContextVoid, ImGui::EndPopup, false, __VA_ARGS__)
#define with_Table(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginTable, ImGui::EndTable, false, __VA_ARGS__)
#define with_TabBar(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginTabBar, ImGui::EndTabBar, false, __VA_ARGS__)
#define with_TabItem(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginTabItem, ImGui::EndTabItem, false, __VA_ARGS__)
#define with_DragDropSource(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::BeginDragDropSource, ImGui::EndDragDropSource, false, __VA_ARGS__)
#define with_TreeNode(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::TreeNode, ImGui::TreePop, false, __VA_ARGS__)
#define with_TreeNodeV(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::TreeNodeV, ImGui::TreePop, false, __VA_ARGS__)
#define with_TreeNodeEx(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::TreeNodeEx, ImGui::TreePop, false, __VA_ARGS__)
#define with_TreeNodeExV(...) IMGUI_SUGAR_SCOPED_BOOL(ImGui::TreeNodeExV, ImGui::TreePop, false, __VA_ARGS__)
#define with_TooltipOnHover IMGUI_SUGAR_SCOPED_BOOL_0(ImGuiSugar::BeginTooltip, ImGui::EndTooltip, false)
#define with_DragDropTarget IMGUI_SUGAR_SCOPED_BOOL_0(ImGui::BeginDragDropTarget, ImGui::EndDragDropTarget, false)
#define with_MainMenuBar IMGUI_SUGAR_SCOPED_BOOL_0(ImGui::BeginMainMenuBar, ImGui::EndMainMenuBar, false)
#define with_MenuBar IMGUI_SUGAR_SCOPED_BOOL_0(ImGui::BeginMenuBar, ImGui::EndMenuBar, false)
#define with_Group IMGUI_SUGAR_SCOPED_VOID_0(ImGui::BeginGroup, ImGui::EndGroup)
#define with_Tooltip IMGUI_SUGAR_SCOPED_VOID_0(ImGui::BeginTooltip, ImGui::EndTooltip)
#define with_Font(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushFont, ImGui::PopFont, __VA_ARGS__)
#define with_AllowKeyboardFocus(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushAllowKeyboardFocus, ImGui::PopAllowKeyboardFocus, __VA_ARGS__)
#define with_ButtonRepeat(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushButtonRepeat, ImGui::PopButtonRepeat, __VA_ARGS__)
#define with_ItemWidth(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushItemWidth, ImGui::PopItemWidth, __VA_ARGS__)
#define with_TextWrapPos(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushTextWrapPos, ImGui::PopTextWrapPos, __VA_ARGS__)
#define with_ID(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushID, ImGui::PopID, __VA_ARGS__)
#define with_ClipRect(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushClipRect, ImGui::PopClipRect, __VA_ARGS__)
#define with_TextureID(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushTextureID, ImGui::PopTextureID, __VA_ARGS__)
// Non self scoped guards (managed by parent scope)
#define set_Font(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushFont, ImGui::PopFont, __VA_ARGS__)
#define set_AllowKeyboardFocus(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushAllowKeyboardFocus, ImGui::PopAllowKeyboardFocus, __VA_ARGS__)
#define set_ButtonRepeat(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushButtonRepeat, ImGui::PopButtonRepeat, __VA_ARGS__)
#define set_ItemWidth(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushItemWidth, ImGui::PopItemWidth, __VA_ARGS__)
#define set_TextWrapPos(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushTextWrapPos, ImGui::PopTextWrapPos, __VA_ARGS__)
#define set_ID(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushID, ImGui::PopID, __VA_ARGS__)
#define set_ClipRect(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushClipRect, ImGui::PopClipRect, __VA_ARGS__)
#define set_TextureID(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushTextureID, ImGui::PopTextureID, __VA_ARGS__)
// Special case (overloaded functions StyleColor and StyleVar)
#define set_StyleColor(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushStyleColor, ImGuiSugar::PopStyleColor, __VA_ARGS__)
#define set_StyleVar(...) IMGUI_SUGAR_PARENT_SCOPED_VOID_N(ImGui::PushStyleVar, ImGuiSugar::PopStyleVar, __VA_ARGS__)
#define with_StyleColor(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushStyleColor, ImGuiSugar::PopStyleColor, __VA_ARGS__)
#define with_StyleVar(...) IMGUI_SUGAR_SCOPED_VOID_N(ImGui::PushStyleVar, ImGuiSugar::PopStyleVar, __VA_ARGS__)
// Non RAII
#define with_CollapsingHeader(...) if (ImGui::CollapsingHeader(__VA_ARGS__))
#define with_MenuItem(...) if (ImGui::MenuItem(__VA_ARGS__))
// clang-format on
|
