OXYGENHUB
# 9120e87480a6 enhanced-x16-emulator / src / extern / imgui / imgui_tables.cpp
238.8 KiB · C++ · last changed chore(): initial commit 25 days ago source blame history raw
1
// dear imgui, v1.91.5
2
// (tables and columns code)
3
4
/*
5
6
Index of this file:
7
8
// [SECTION] Commentary
9
// [SECTION] Header mess
10
// [SECTION] Tables: Main code
11
// [SECTION] Tables: Simple accessors
12
// [SECTION] Tables: Row changes
13
// [SECTION] Tables: Columns changes
14
// [SECTION] Tables: Columns width management
15
// [SECTION] Tables: Drawing
16
// [SECTION] Tables: Sorting
17
// [SECTION] Tables: Headers
18
// [SECTION] Tables: Context Menu
19
// [SECTION] Tables: Settings (.ini data)
20
// [SECTION] Tables: Garbage Collection
21
// [SECTION] Tables: Debugging
22
// [SECTION] Columns, BeginColumns, EndColumns, etc.
23
24
*/
25
26
// Navigating this file:
27
// - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot.
28
// - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments.
29
// - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments.
30
31
//-----------------------------------------------------------------------------
32
// [SECTION] Commentary
33
//-----------------------------------------------------------------------------
34
35
//-----------------------------------------------------------------------------
36
// Typical tables call flow: (root level is generally public API):
37
//-----------------------------------------------------------------------------
38
// - BeginTable()                               user begin into a table
39
//    | BeginChild()                            - (if ScrollX/ScrollY is set)
40
//    | TableBeginInitMemory()                  - first time table is used
41
//    | TableResetSettings()                    - on settings reset
42
//    | TableLoadSettings()                     - on settings load
43
//    | TableBeginApplyRequests()               - apply queued resizing/reordering/hiding requests
44
//    | - TableSetColumnWidth()                 - apply resizing width (for mouse resize, often requested by previous frame)
45
//    |    - TableUpdateColumnsWeightFromWidth()- recompute columns weights (of stretch columns) from their respective width
46
// - TableSetupColumn()                         user submit columns details (optional)
47
// - TableSetupScrollFreeze()                   user submit scroll freeze information (optional)
48
//-----------------------------------------------------------------------------
49
// - TableUpdateLayout() [Internal]             followup to BeginTable(): setup everything: widths, columns positions, clipping rectangles. Automatically called by the FIRST call to TableNextRow() or TableHeadersRow().
50
//    | TableSetupDrawChannels()                - setup ImDrawList channels
51
//    | TableUpdateBorders()                    - detect hovering columns for resize, ahead of contents submission
52
//    | TableBeginContextMenuPopup()
53
//    | - TableDrawDefaultContextMenu()         - draw right-click context menu contents
54
//-----------------------------------------------------------------------------
55
// - TableHeadersRow() or TableHeader()         user submit a headers row (optional)
56
//    | TableSortSpecsClickColumn()             - when left-clicked: alter sort order and sort direction
57
//    | TableOpenContextMenu()                  - when right-clicked: trigger opening of the default context menu
58
// - TableGetSortSpecs()                        user queries updated sort specs (optional, generally after submitting headers)
59
// - TableNextRow()                             user begin into a new row (also automatically called by TableHeadersRow())
60
//    | TableEndRow()                           - finish existing row
61
//    | TableBeginRow()                         - add a new row
62
// - TableSetColumnIndex() / TableNextColumn()  user begin into a cell
63
//    | TableEndCell()                          - close existing column/cell
64
//    | TableBeginCell()                        - enter into current column/cell
65
// - [...]                                      user emit contents
66
//-----------------------------------------------------------------------------
67
// - EndTable()                                 user ends the table
68
//    | TableDrawBorders()                      - draw outer borders, inner vertical borders
69
//    | TableMergeDrawChannels()                - merge draw channels if clipping isn't required
70
//    | EndChild()                              - (if ScrollX/ScrollY is set)
71
//-----------------------------------------------------------------------------
72
73
//-----------------------------------------------------------------------------
74
// TABLE SIZING
75
//-----------------------------------------------------------------------------
76
// (Read carefully because this is subtle but it does make sense!)
77
//-----------------------------------------------------------------------------
78
// About 'outer_size':
79
// Its meaning needs to differ slightly depending on if we are using ScrollX/ScrollY flags.
80
// Default value is ImVec2(0.0f, 0.0f).
81
//   X
82
//   - outer_size.x <= 0.0f  ->  Right-align from window/work-rect right-most edge. With -FLT_MIN or 0.0f will align exactly on right-most edge.
83
//   - outer_size.x  > 0.0f  ->  Set Fixed width.
84
//   Y with ScrollX/ScrollY disabled: we output table directly in current window
85
//   - outer_size.y  < 0.0f  ->  Bottom-align (but will auto extend, unless _NoHostExtendY is set). Not meaningful if parent window can vertically scroll.
86
//   - outer_size.y  = 0.0f  ->  No minimum height (but will auto extend, unless _NoHostExtendY is set)
87
//   - outer_size.y  > 0.0f  ->  Set Minimum height (but will auto extend, unless _NoHostExtendY is set)
88
//   Y with ScrollX/ScrollY enabled: using a child window for scrolling
89
//   - outer_size.y  < 0.0f  ->  Bottom-align. Not meaningful if parent window can vertically scroll.
90
//   - outer_size.y  = 0.0f  ->  Bottom-align, consistent with BeginChild(). Not recommended unless table is last item in parent window.
91
//   - outer_size.y  > 0.0f  ->  Set Exact height. Recommended when using Scrolling on any axis.
92
//-----------------------------------------------------------------------------
93
// Outer size is also affected by the NoHostExtendX/NoHostExtendY flags.
94
// Important to note how the two flags have slightly different behaviors!
95
//   - ImGuiTableFlags_NoHostExtendX -> Make outer width auto-fit to columns (overriding outer_size.x value). Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.
96
//   - ImGuiTableFlags_NoHostExtendY -> Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY is disabled. Data below the limit will be clipped and not visible.
97
// In theory ImGuiTableFlags_NoHostExtendY could be the default and any non-scrolling tables with outer_size.y != 0.0f would use exact height.
98
// This would be consistent but perhaps less useful and more confusing (as vertically clipped items are not useful and not easily noticeable).
99
//-----------------------------------------------------------------------------
100
// About 'inner_width':
101
//   With ScrollX disabled:
102
//   - inner_width          ->  *ignored*
103
//   With ScrollX enabled:
104
//   - inner_width  < 0.0f  ->  *illegal* fit in known width (right align from outer_size.x) <-- weird
105
//   - inner_width  = 0.0f  ->  fit in outer_width: Fixed size columns will take space they need (if avail, otherwise shrink down), Stretch columns becomes Fixed columns.
106
//   - inner_width  > 0.0f  ->  override scrolling width, generally to be larger than outer_size.x. Fixed column take space they need (if avail, otherwise shrink down), Stretch columns share remaining space!
107
//-----------------------------------------------------------------------------
108
// Details:
109
// - If you want to use Stretch columns with ScrollX, you generally need to specify 'inner_width' otherwise the concept
110
//   of "available space" doesn't make sense.
111
// - Even if not really useful, we allow 'inner_width < outer_size.x' for consistency and to facilitate understanding
112
//   of what the value does.
113
//-----------------------------------------------------------------------------
114
115
//-----------------------------------------------------------------------------
116
// COLUMNS SIZING POLICIES
117
// (Reference: ImGuiTableFlags_SizingXXX flags and ImGuiTableColumnFlags_WidthXXX flags)
118
//-----------------------------------------------------------------------------
119
// About overriding column sizing policy and width/weight with TableSetupColumn():
120
// We use a default parameter of -1 for 'init_width'/'init_weight'.
121
//   - with ImGuiTableColumnFlags_WidthFixed,    init_width  <= 0 (default)  --> width is automatic
122
//   - with ImGuiTableColumnFlags_WidthFixed,    init_width  >  0 (explicit) --> width is custom
123
//   - with ImGuiTableColumnFlags_WidthStretch,  init_weight <= 0 (default)  --> weight is 1.0f
124
//   - with ImGuiTableColumnFlags_WidthStretch,  init_weight >  0 (explicit) --> weight is custom
125
// Widths are specified _without_ CellPadding. If you specify a width of 100.0f, the column will be cover (100.0f + Padding * 2.0f)
126
// and you can fit a 100.0f wide item in it without clipping and with padding honored.
127
//-----------------------------------------------------------------------------
128
// About default sizing policy (if you don't specify a ImGuiTableColumnFlags_WidthXXXX flag)
129
//   - with Table policy ImGuiTableFlags_SizingFixedFit      --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is equal to contents width
130
//   - with Table policy ImGuiTableFlags_SizingFixedSame     --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is max of all contents width
131
//   - with Table policy ImGuiTableFlags_SizingStretchSame   --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is 1.0f
132
//   - with Table policy ImGuiTableFlags_SizingStretchWeight --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is proportional to contents
133
// Default Width and default Weight can be overridden when calling TableSetupColumn().
134
//-----------------------------------------------------------------------------
135
// About mixing Fixed/Auto and Stretch columns together:
136
//   - the typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns.
137
//   - using mixed policies with ScrollX does not make much sense, as using Stretch columns with ScrollX does not make much sense in the first place!
138
//     that is, unless 'inner_width' is passed to BeginTable() to explicitly provide a total width to layout columns in.
139
//   - when using ImGuiTableFlags_SizingFixedSame with mixed columns, only the Fixed/Auto columns will match their widths to the width of the maximum contents.
140
//   - when using ImGuiTableFlags_SizingStretchSame with mixed columns, only the Stretch columns will match their weights/widths.
141
//-----------------------------------------------------------------------------
142
// About using column width:
143
// If a column is manually resizable or has a width specified with TableSetupColumn():
144
//   - you may use GetContentRegionAvail().x to query the width available in a given column.
145
//   - right-side alignment features such as SetNextItemWidth(-x) or PushItemWidth(-x) will rely on this width.
146
// If the column is not resizable and has no width specified with TableSetupColumn():
147
//   - its width will be automatic and be set to the max of items submitted.
148
//   - therefore you generally cannot have ALL items of the columns use e.g. SetNextItemWidth(-FLT_MIN).
149
//   - but if the column has one or more items of known/fixed size, this will become the reference width used by SetNextItemWidth(-FLT_MIN).
150
//-----------------------------------------------------------------------------
151
152
153
//-----------------------------------------------------------------------------
154
// TABLES CLIPPING/CULLING
155
//-----------------------------------------------------------------------------
156
// About clipping/culling of Rows in Tables:
157
// - For large numbers of rows, it is recommended you use ImGuiListClipper to submit only visible rows.
158
//   ImGuiListClipper is reliant on the fact that rows are of equal height.
159
//   See 'Demo->Tables->Vertical Scrolling' or 'Demo->Tables->Advanced' for a demo of using the clipper.
160
// - Note that auto-resizing columns don't play well with using the clipper.
161
//   By default a table with _ScrollX but without _Resizable will have column auto-resize.
162
//   So, if you want to use the clipper, make sure to either enable _Resizable, either setup columns width explicitly with _WidthFixed.
163
//-----------------------------------------------------------------------------
164
// About clipping/culling of Columns in Tables:
165
// - Both TableSetColumnIndex() and TableNextColumn() return true when the column is visible or performing
166
//   width measurements. Otherwise, you may skip submitting the contents of a cell/column, BUT ONLY if you know
167
//   it is not going to contribute to row height.
168
//   In many situations, you may skip submitting contents for every column but one (e.g. the first one).
169
// - Case A: column is not hidden by user, and at least partially in sight (most common case).
170
// - Case B: column is clipped / out of sight (because of scrolling or parent ClipRect): TableNextColumn() return false as a hint but we still allow layout output.
171
// - Case C: column is hidden explicitly by the user (e.g. via the context menu, or _DefaultHide column flag, etc.).
172
//
173
//                        [A]         [B]          [C]
174
//  TableNextColumn():    true        false        false       -> [userland] when TableNextColumn() / TableSetColumnIndex() returns false, user can skip submitting items but only if the column doesn't contribute to row height.
175
//          SkipItems:    false       false        true        -> [internal] when SkipItems is true, most widgets will early out if submitted, resulting is no layout output.
176
//           ClipRect:    normal      zero-width   zero-width  -> [internal] when ClipRect is zero, ItemAdd() will return false and most widgets will early out mid-way.
177
//  ImDrawList output:    normal      dummy        dummy       -> [internal] when using the dummy channel, ImDrawList submissions (if any) will be wasted (because cliprect is zero-width anyway).
178
//
179
// - We need to distinguish those cases because non-hidden columns that are clipped outside of scrolling bounds should still contribute their height to the row.
180
//   However, in the majority of cases, the contribution to row height is the same for all columns, or the tallest cells are known by the programmer.
181
//-----------------------------------------------------------------------------
182
// About clipping/culling of whole Tables:
183
// - Scrolling tables with a known outer size can be clipped earlier as BeginTable() will return false.
184
//-----------------------------------------------------------------------------
185
186
//-----------------------------------------------------------------------------
187
// [SECTION] Header mess
188
//-----------------------------------------------------------------------------
189
190
#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
191
#define _CRT_SECURE_NO_WARNINGS
192
#endif
193
194
#ifndef IMGUI_DEFINE_MATH_OPERATORS
195
#define IMGUI_DEFINE_MATH_OPERATORS
196
#endif
197
198
#include "imgui.h"
199
#ifndef IMGUI_DISABLE
200
#include "imgui_internal.h"
201
202
// System includes
203
#include <stdint.h>     // intptr_t
204
205
// Visual Studio warnings
206
#ifdef _MSC_VER
207
#pragma warning (disable: 4127)     // condition expression is constant
208
#pragma warning (disable: 4996)     // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen
209
#if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later
210
#pragma warning (disable: 5054)     // operator '|': deprecated between enumerations of different types
211
#endif
212
#pragma warning (disable: 26451)    // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to a 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2).
213
#pragma warning (disable: 26812)    // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3).
214
#endif
215
216
// Clang/GCC warnings with -Weverything
217
#if defined(__clang__)
218
#if __has_warning("-Wunknown-warning-option")
219
#pragma clang diagnostic ignored "-Wunknown-warning-option"         // warning: unknown warning group 'xxx'                      // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great!
220
#endif
221
#pragma clang diagnostic ignored "-Wunknown-pragmas"                // warning: unknown warning group 'xxx'
222
#pragma clang diagnostic ignored "-Wold-style-cast"                 // warning: use of old-style cast                            // yes, they are more terse.
223
#pragma clang diagnostic ignored "-Wfloat-equal"                    // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok.
224
#pragma clang diagnostic ignored "-Wformat-nonliteral"              // warning: format string is not a string literal            // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code.
225
#pragma clang diagnostic ignored "-Wsign-conversion"                // warning: implicit conversion changes signedness
226
#pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant"  // warning: zero as null pointer constant                    // some standard header variations use #define NULL 0
227
#pragma clang diagnostic ignored "-Wdouble-promotion"               // warning: implicit conversion from 'float' to 'double' when passing argument to function  // using printf() is a misery with this as C++ va_arg ellipsis changes float to double.
228
#pragma clang diagnostic ignored "-Wenum-enum-conversion"           // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_')
229
#pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated
230
#pragma clang diagnostic ignored "-Wimplicit-int-float-conversion"  // warning: implicit conversion from 'xxx' to 'float' may lose precision
231
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"            // warning: 'xxx' is an unsafe pointer used for buffer access
232
#pragma clang diagnostic ignored "-Wnontrivial-memaccess"           // warning: first argument in call to 'memset' is a pointer to non-trivially copyable type
233
#elif defined(__GNUC__)
234
#pragma GCC diagnostic ignored "-Wpragmas"                          // warning: unknown option after '#pragma GCC diagnostic' kind
235
#pragma GCC diagnostic ignored "-Wformat-nonliteral"                // warning: format not a string literal, format string not checked
236
#pragma GCC diagnostic ignored "-Wclass-memaccess"                  // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead
237
#endif
238
239
//-----------------------------------------------------------------------------
240
// [SECTION] Tables: Main code
241
//-----------------------------------------------------------------------------
242
// - TableFixFlags() [Internal]
243
// - TableFindByID() [Internal]
244
// - BeginTable()
245
// - BeginTableEx() [Internal]
246
// - TableBeginInitMemory() [Internal]
247
// - TableBeginApplyRequests() [Internal]
248
// - TableSetupColumnFlags() [Internal]
249
// - TableUpdateLayout() [Internal]
250
// - TableUpdateBorders() [Internal]
251
// - EndTable()
252
// - TableSetupColumn()
253
// - TableSetupScrollFreeze()
254
//-----------------------------------------------------------------------------
255
256
// Configuration
257
static const int TABLE_DRAW_CHANNEL_BG0 = 0;
258
static const int TABLE_DRAW_CHANNEL_BG2_FROZEN = 1;
259
static const int TABLE_DRAW_CHANNEL_NOCLIP = 2;                     // When using ImGuiTableFlags_NoClip (this becomes the last visible channel)
260
static const float TABLE_BORDER_SIZE                     = 1.0f;    // FIXME-TABLE: Currently hard-coded because of clipping assumptions with outer borders rendering.
261
static const float TABLE_RESIZE_SEPARATOR_HALF_THICKNESS = 4.0f;    // Extend outside inner borders.
262
static const float TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER = 0.06f;   // Delay/timer before making the hover feedback (color+cursor) visible because tables/columns tends to be more cramped.
263
264
// Helper
265
inline ImGuiTableFlags TableFixFlags(ImGuiTableFlags flags, ImGuiWindow* outer_window)
266
{
267
    // Adjust flags: set default sizing policy
268
    if ((flags & ImGuiTableFlags_SizingMask_) == 0)
269
        flags |= ((flags & ImGuiTableFlags_ScrollX) || (outer_window->Flags & ImGuiWindowFlags_AlwaysAutoResize)) ? ImGuiTableFlags_SizingFixedFit : ImGuiTableFlags_SizingStretchSame;
270
271
    // Adjust flags: enable NoKeepColumnsVisible when using ImGuiTableFlags_SizingFixedSame
272
    if ((flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame)
273
        flags |= ImGuiTableFlags_NoKeepColumnsVisible;
274
275
    // Adjust flags: enforce borders when resizable
276
    if (flags & ImGuiTableFlags_Resizable)
277
        flags |= ImGuiTableFlags_BordersInnerV;
278
279
    // Adjust flags: disable NoHostExtendX/NoHostExtendY if we have any scrolling going on
280
    if (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY))
281
        flags &= ~(ImGuiTableFlags_NoHostExtendX | ImGuiTableFlags_NoHostExtendY);
282
283
    // Adjust flags: NoBordersInBodyUntilResize takes priority over NoBordersInBody
284
    if (flags & ImGuiTableFlags_NoBordersInBodyUntilResize)
285
        flags &= ~ImGuiTableFlags_NoBordersInBody;
286
287
    // Adjust flags: disable saved settings if there's nothing to save
288
    if ((flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Sortable)) == 0)
289
        flags |= ImGuiTableFlags_NoSavedSettings;
290
291
    // Inherit _NoSavedSettings from top-level window (child windows always have _NoSavedSettings set)
292
    if (outer_window->RootWindow->Flags & ImGuiWindowFlags_NoSavedSettings)
293
        flags |= ImGuiTableFlags_NoSavedSettings;
294
295
    return flags;
296
}
297
298
ImGuiTable* ImGui::TableFindByID(ImGuiID id)
299
{
300
    ImGuiContext& g = *GImGui;
301
    return g.Tables.GetByKey(id);
302
}
303
304
// Read about "TABLE SIZING" at the top of this file.
305
bool    ImGui::BeginTable(const char* str_id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width)
306
{
307
    ImGuiID id = GetID(str_id);
308
    return BeginTableEx(str_id, id, columns_count, flags, outer_size, inner_width);
309
}
310
311
bool    ImGui::BeginTableEx(const char* name, ImGuiID id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width)
312
{
313
    ImGuiContext& g = *GImGui;
314
    ImGuiWindow* outer_window = GetCurrentWindow();
315
    if (outer_window->SkipItems) // Consistent with other tables + beneficial side effect that assert on miscalling EndTable() will be more visible.
316
        return false;
317
318
    // Sanity checks
319
    IM_ASSERT(columns_count > 0 && columns_count < IMGUI_TABLE_MAX_COLUMNS);
320
    if (flags & ImGuiTableFlags_ScrollX)
321
        IM_ASSERT(inner_width >= 0.0f);
322
323
    // If an outer size is specified ahead we will be able to early out when not visible. Exact clipping criteria may evolve.
324
    // FIXME: coarse clipping because access to table data causes two issues:
325
    // - instance numbers varying/unstable. may not be a direct problem for users, but could make outside access broken or confusing, e.g. TestEngine.
326
    // - can't implement support for ImGuiChildFlags_ResizeY as we need to somehow pull the height data from somewhere. this also needs stable instance numbers.
327
    // The side-effects of accessing table data on coarse clip would be:
328
    // - always reserving the pooled ImGuiTable data ahead for a fully clipped table (minor IMHO). Also the 'outer_window_is_measuring_size' criteria may already be defeating this in some situations.
329
    // - always performing the GetOrAddByKey() O(log N) query in g.Tables.Map[].
330
    const bool use_child_window = (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) != 0;
331
    const ImVec2 avail_size = GetContentRegionAvail();
332
    const ImVec2 actual_outer_size = ImTrunc(CalcItemSize(outer_size, ImMax(avail_size.x, 1.0f), use_child_window ? ImMax(avail_size.y, 1.0f) : 0.0f));
333
    const ImRect outer_rect(outer_window->DC.CursorPos, outer_window->DC.CursorPos + actual_outer_size);
334
    const bool outer_window_is_measuring_size = (outer_window->AutoFitFramesX > 0) || (outer_window->AutoFitFramesY > 0); // Doesn't apply to AlwaysAutoResize windows!
335
    if (use_child_window && IsClippedEx(outer_rect, 0) && !outer_window_is_measuring_size)
336
    {
337
        ItemSize(outer_rect);
338
        ItemAdd(outer_rect, id);
339
        return false;
340
    }
341
342
    // [DEBUG] Debug break requested by user
343
    if (g.DebugBreakInTable == id)
344
        IM_DEBUG_BREAK();
345
346
    // Acquire storage for the table
347
    ImGuiTable* table = g.Tables.GetOrAddByKey(id);
348
349
    // Acquire temporary buffers
350
    const int table_idx = g.Tables.GetIndex(table);
351
    if (++g.TablesTempDataStacked > g.TablesTempData.Size)
352
        g.TablesTempData.resize(g.TablesTempDataStacked, ImGuiTableTempData());
353
    ImGuiTableTempData* temp_data = table->TempData = &g.TablesTempData[g.TablesTempDataStacked - 1];
354
    temp_data->TableIndex = table_idx;
355
    table->DrawSplitter = &table->TempData->DrawSplitter;
356
    table->DrawSplitter->Clear();
357
358
    // Fix flags
359
    table->IsDefaultSizingPolicy = (flags & ImGuiTableFlags_SizingMask_) == 0;
360
    flags = TableFixFlags(flags, outer_window);
361
362
    // Initialize
363
    const int previous_frame_active = table->LastFrameActive;
364
    const int instance_no = (previous_frame_active != g.FrameCount) ? 0 : table->InstanceCurrent + 1;
365
    const ImGuiTableFlags previous_flags = table->Flags;
366
    table->ID = id;
367
    table->Flags = flags;
368
    table->LastFrameActive = g.FrameCount;
369
    table->OuterWindow = table->InnerWindow = outer_window;
370
    table->ColumnsCount = columns_count;
371
    table->IsLayoutLocked = false;
372
    table->InnerWidth = inner_width;
373
    temp_data->UserOuterSize = outer_size;
374
375
    // Instance data (for instance 0, TableID == TableInstanceID)
376
    ImGuiID instance_id;
377
    table->InstanceCurrent = (ImS16)instance_no;
378
    if (instance_no > 0)
379
    {
380
        IM_ASSERT(table->ColumnsCount == columns_count && "BeginTable(): Cannot change columns count mid-frame while preserving same ID");
381
        if (table->InstanceDataExtra.Size < instance_no)
382
            table->InstanceDataExtra.push_back(ImGuiTableInstanceData());
383
        instance_id = GetIDWithSeed(instance_no, GetIDWithSeed("##Instances", NULL, id)); // Push "##Instances" followed by (int)instance_no in ID stack.
384
    }
385
    else
386
    {
387
        instance_id = id;
388
    }
389
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
390
    table_instance->TableInstanceID = instance_id;
391
392
    // When not using a child window, WorkRect.Max will grow as we append contents.
393
    if (use_child_window)
394
    {
395
        // Ensure no vertical scrollbar appears if we only want horizontal one, to make flag consistent
396
        // (we have no other way to disable vertical scrollbar of a window while keeping the horizontal one showing)
397
        ImVec2 override_content_size(FLT_MAX, FLT_MAX);
398
        if ((flags & ImGuiTableFlags_ScrollX) && !(flags & ImGuiTableFlags_ScrollY))
399
            override_content_size.y = FLT_MIN;
400
401
        // Ensure specified width (when not specified, Stretched columns will act as if the width == OuterWidth and
402
        // never lead to any scrolling). We don't handle inner_width < 0.0f, we could potentially use it to right-align
403
        // based on the right side of the child window work rect, which would require knowing ahead if we are going to
404
        // have decoration taking horizontal spaces (typically a vertical scrollbar).
405
        if ((flags & ImGuiTableFlags_ScrollX) && inner_width > 0.0f)
406
            override_content_size.x = inner_width;
407
408
        if (override_content_size.x != FLT_MAX || override_content_size.y != FLT_MAX)
409
            SetNextWindowContentSize(ImVec2(override_content_size.x != FLT_MAX ? override_content_size.x : 0.0f, override_content_size.y != FLT_MAX ? override_content_size.y : 0.0f));
410
411
        // Reset scroll if we are reactivating it
412
        if ((previous_flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) == 0)
413
            SetNextWindowScroll(ImVec2(0.0f, 0.0f));
414
415
        // Create scrolling region (without border and zero window padding)
416
        ImGuiWindowFlags child_window_flags = (flags & ImGuiTableFlags_ScrollX) ? ImGuiWindowFlags_HorizontalScrollbar : ImGuiWindowFlags_None;
417
        BeginChildEx(name, instance_id, outer_rect.GetSize(), ImGuiChildFlags_None, child_window_flags);
418
        table->InnerWindow = g.CurrentWindow;
419
        table->WorkRect = table->InnerWindow->WorkRect;
420
        table->OuterRect = table->InnerWindow->Rect();
421
        table->InnerRect = table->InnerWindow->InnerRect;
422
        IM_ASSERT(table->InnerWindow->WindowPadding.x == 0.0f && table->InnerWindow->WindowPadding.y == 0.0f && table->InnerWindow->WindowBorderSize == 0.0f);
423
424
        // Allow submitting when host is measuring
425
        if (table->InnerWindow->SkipItems && outer_window_is_measuring_size)
426
            table->InnerWindow->SkipItems = false;
427
428
        // When using multiple instances, ensure they have the same amount of horizontal decorations (aka vertical scrollbar) so stretched columns can be aligned)
429
        if (instance_no == 0)
430
        {
431
            table->HasScrollbarYPrev = table->HasScrollbarYCurr;
432
            table->HasScrollbarYCurr = false;
433
        }
434
        table->HasScrollbarYCurr |= table->InnerWindow->ScrollbarY;
435
    }
436
    else
437
    {
438
        // For non-scrolling tables, WorkRect == OuterRect == InnerRect.
439
        // But at this point we do NOT have a correct value for .Max.y (unless a height has been explicitly passed in). It will only be updated in EndTable().
440
        table->WorkRect = table->OuterRect = table->InnerRect = outer_rect;
441
        table->HasScrollbarYPrev = table->HasScrollbarYCurr = false;
442
    }
443
444
    // Push a standardized ID for both child-using and not-child-using tables
445
    PushOverrideID(id);
446
    if (instance_no > 0)
447
        PushOverrideID(instance_id); // FIXME: Somehow this is not resolved by stack-tool, even tho GetIDWithSeed() submitted the symbol.
448
449
    // Backup a copy of host window members we will modify
450
    ImGuiWindow* inner_window = table->InnerWindow;
451
    table->HostIndentX = inner_window->DC.Indent.x;
452
    table->HostClipRect = inner_window->ClipRect;
453
    table->HostSkipItems = inner_window->SkipItems;
454
    temp_data->HostBackupWorkRect = inner_window->WorkRect;
455
    temp_data->HostBackupParentWorkRect = inner_window->ParentWorkRect;
456
    temp_data->HostBackupColumnsOffset = outer_window->DC.ColumnsOffset;
457
    temp_data->HostBackupPrevLineSize = inner_window->DC.PrevLineSize;
458
    temp_data->HostBackupCurrLineSize = inner_window->DC.CurrLineSize;
459
    temp_data->HostBackupCursorMaxPos = inner_window->DC.CursorMaxPos;
460
    temp_data->HostBackupItemWidth = outer_window->DC.ItemWidth;
461
    temp_data->HostBackupItemWidthStackSize = outer_window->DC.ItemWidthStack.Size;
462
    inner_window->DC.PrevLineSize = inner_window->DC.CurrLineSize = ImVec2(0.0f, 0.0f);
463
464
    // Make borders not overlap our contents by offsetting HostClipRect (#6765, #7428, #3752)
465
    // (we normally shouldn't alter HostClipRect as we rely on TableMergeDrawChannels() expanding non-clipped column toward the
466
    // limits of that rectangle, in order for ImDrawListSplitter::Merge() to merge the draw commands. However since the overlap
467
    // problem only affect scrolling tables in this case we can get away with doing it without extra cost).
468
    if (inner_window != outer_window)
469
    {
470
        // FIXME: Because inner_window's Scrollbar doesn't know about border size, since it's not encoded in window->WindowBorderSize,
471
        // it already overlaps it and doesn't need an extra offset. Ideally we should be able to pass custom border size with
472
        // different x/y values to BeginChild().
473
        if (flags & ImGuiTableFlags_BordersOuterV)
474
        {
475
            table->HostClipRect.Min.x = ImMin(table->HostClipRect.Min.x + TABLE_BORDER_SIZE, table->HostClipRect.Max.x);
476
            if (inner_window->DecoOuterSizeX2 == 0.0f)
477
                table->HostClipRect.Max.x = ImMax(table->HostClipRect.Max.x - TABLE_BORDER_SIZE, table->HostClipRect.Min.x);
478
        }
479
        if (flags & ImGuiTableFlags_BordersOuterH)
480
        {
481
            table->HostClipRect.Min.y = ImMin(table->HostClipRect.Min.y + TABLE_BORDER_SIZE, table->HostClipRect.Max.y);
482
            if (inner_window->DecoOuterSizeY2 == 0.0f)
483
                table->HostClipRect.Max.y = ImMax(table->HostClipRect.Max.y - TABLE_BORDER_SIZE, table->HostClipRect.Min.y);
484
        }
485
    }
486
487
    // Padding and Spacing
488
    // - None               ........Content..... Pad .....Content........
489
    // - PadOuter           | Pad ..Content..... Pad .....Content.. Pad |
490
    // - PadInner           ........Content.. Pad | Pad ..Content........
491
    // - PadOuter+PadInner  | Pad ..Content.. Pad | Pad ..Content.. Pad |
492
    const bool pad_outer_x = (flags & ImGuiTableFlags_NoPadOuterX) ? false : (flags & ImGuiTableFlags_PadOuterX) ? true : (flags & ImGuiTableFlags_BordersOuterV) != 0;
493
    const bool pad_inner_x = (flags & ImGuiTableFlags_NoPadInnerX) ? false : true;
494
    const float inner_spacing_for_border = (flags & ImGuiTableFlags_BordersInnerV) ? TABLE_BORDER_SIZE : 0.0f;
495
    const float inner_spacing_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) == 0) ? g.Style.CellPadding.x : 0.0f;
496
    const float inner_padding_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) != 0) ? g.Style.CellPadding.x : 0.0f;
497
    table->CellSpacingX1 = inner_spacing_explicit + inner_spacing_for_border;
498
    table->CellSpacingX2 = inner_spacing_explicit;
499
    table->CellPaddingX = inner_padding_explicit;
500
501
    const float outer_padding_for_border = (flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f;
502
    const float outer_padding_explicit = pad_outer_x ? g.Style.CellPadding.x : 0.0f;
503
    table->OuterPaddingX = (outer_padding_for_border + outer_padding_explicit) - table->CellPaddingX;
504
505
    table->CurrentColumn = -1;
506
    table->CurrentRow = -1;
507
    table->RowBgColorCounter = 0;
508
    table->LastRowFlags = ImGuiTableRowFlags_None;
509
    table->InnerClipRect = (inner_window == outer_window) ? table->WorkRect : inner_window->ClipRect;
510
    table->InnerClipRect.ClipWith(table->WorkRect);     // We need this to honor inner_width
511
    table->InnerClipRect.ClipWithFull(table->HostClipRect);
512
    table->InnerClipRect.Max.y = (flags & ImGuiTableFlags_NoHostExtendY) ? ImMin(table->InnerClipRect.Max.y, inner_window->WorkRect.Max.y) : table->HostClipRect.Max.y;
513
514
    table->RowPosY1 = table->RowPosY2 = table->WorkRect.Min.y; // This is needed somehow
515
    table->RowTextBaseline = 0.0f; // This will be cleared again by TableBeginRow()
516
    table->RowCellPaddingY = 0.0f;
517
    table->FreezeRowsRequest = table->FreezeRowsCount = 0; // This will be setup by TableSetupScrollFreeze(), if any
518
    table->FreezeColumnsRequest = table->FreezeColumnsCount = 0;
519
    table->IsUnfrozenRows = true;
520
    table->DeclColumnsCount = table->AngledHeadersCount = 0;
521
    if (previous_frame_active + 1 < g.FrameCount)
522
        table->IsActiveIdInTable = false;
523
    table->AngledHeadersHeight = 0.0f;
524
    temp_data->AngledHeadersExtraWidth = 0.0f;
525
526
    // Using opaque colors facilitate overlapping lines of the grid, otherwise we'd need to improve TableDrawBorders()
527
    table->BorderColorStrong = GetColorU32(ImGuiCol_TableBorderStrong);
528
    table->BorderColorLight = GetColorU32(ImGuiCol_TableBorderLight);
529
530
    // Make table current
531
    g.CurrentTable = table;
532
    outer_window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX();
533
    outer_window->DC.CurrentTableIdx = table_idx;
534
    if (inner_window != outer_window) // So EndChild() within the inner window can restore the table properly.
535
        inner_window->DC.CurrentTableIdx = table_idx;
536
537
    if ((previous_flags & ImGuiTableFlags_Reorderable) && (flags & ImGuiTableFlags_Reorderable) == 0)
538
        table->IsResetDisplayOrderRequest = true;
539
540
    // Mark as used to avoid GC
541
    if (table_idx >= g.TablesLastTimeActive.Size)
542
        g.TablesLastTimeActive.resize(table_idx + 1, -1.0f);
543
    g.TablesLastTimeActive[table_idx] = (float)g.Time;
544
    temp_data->LastTimeActive = (float)g.Time;
545
    table->MemoryCompacted = false;
546
547
    // Setup memory buffer (clear data if columns count changed)
548
    ImGuiTableColumn* old_columns_to_preserve = NULL;
549
    void* old_columns_raw_data = NULL;
550
    const int old_columns_count = table->Columns.size();
551
    if (old_columns_count != 0 && old_columns_count != columns_count)
552
    {
553
        // Attempt to preserve width on column count change (#4046)
554
        old_columns_to_preserve = table->Columns.Data;
555
        old_columns_raw_data = table->RawData;
556
        table->RawData = NULL;
557
    }
558
    if (table->RawData == NULL)
559
    {
560
        TableBeginInitMemory(table, columns_count);
561
        table->IsInitializing = table->IsSettingsRequestLoad = true;
562
    }
563
    if (table->IsResetAllRequest)
564
        TableResetSettings(table);
565
    if (table->IsInitializing)
566
    {
567
        // Initialize
568
        table->SettingsOffset = -1;
569
        table->IsSortSpecsDirty = true;
570
        table->InstanceInteracted = -1;
571
        table->ContextPopupColumn = -1;
572
        table->ReorderColumn = table->ResizedColumn = table->LastResizedColumn = -1;
573
        table->AutoFitSingleColumn = -1;
574
        table->HoveredColumnBody = table->HoveredColumnBorder = -1;
575
        for (int n = 0; n < columns_count; n++)
576
        {
577
            ImGuiTableColumn* column = &table->Columns[n];
578
            if (old_columns_to_preserve && n < old_columns_count)
579
            {
580
                // FIXME: We don't attempt to preserve column order in this path.
581
                *column = old_columns_to_preserve[n];
582
            }
583
            else
584
            {
585
                float width_auto = column->WidthAuto;
586
                *column = ImGuiTableColumn();
587
                column->WidthAuto = width_auto;
588
                column->IsPreserveWidthAuto = true; // Preserve WidthAuto when reinitializing a live table: not technically necessary but remove a visible flicker
589
                column->IsEnabled = column->IsUserEnabled = column->IsUserEnabledNextFrame = true;
590
            }
591
            column->DisplayOrder = table->DisplayOrderToIndex[n] = (ImGuiTableColumnIdx)n;
592
        }
593
    }
594
    if (old_columns_raw_data)
595
        IM_FREE(old_columns_raw_data);
596
597
    // Load settings
598
    if (table->IsSettingsRequestLoad)
599
        TableLoadSettings(table);
600
601
    // Handle DPI/font resize
602
    // This is designed to facilitate DPI changes with the assumption that e.g. style.CellPadding has been scaled as well.
603
    // It will also react to changing fonts with mixed results. It doesn't need to be perfect but merely provide a decent transition.
604
    // FIXME-DPI: Provide consistent standards for reference size. Perhaps using g.CurrentDpiScale would be more self explanatory.
605
    // This is will lead us to non-rounded WidthRequest in columns, which should work but is a poorly tested path.
606
    const float new_ref_scale_unit = g.FontSize; // g.Font->GetCharAdvance('A') ?
607
    if (table->RefScale != 0.0f && table->RefScale != new_ref_scale_unit)
608
    {
609
        const float scale_factor = new_ref_scale_unit / table->RefScale;
610
        //IMGUI_DEBUG_PRINT("[table] %08X RefScaleUnit %.3f -> %.3f, scaling width by %.3f\n", table->ID, table->RefScaleUnit, new_ref_scale_unit, scale_factor);
611
        for (int n = 0; n < columns_count; n++)
612
            table->Columns[n].WidthRequest = table->Columns[n].WidthRequest * scale_factor;
613
    }
614
    table->RefScale = new_ref_scale_unit;
615
616
    // Disable output until user calls TableNextRow() or TableNextColumn() leading to the TableUpdateLayout() call..
617
    // This is not strictly necessary but will reduce cases were "out of table" output will be misleading to the user.
618
    // Because we cannot safely assert in EndTable() when no rows have been created, this seems like our best option.
619
    inner_window->SkipItems = true;
620
621
    // Clear names
622
    // At this point the ->NameOffset field of each column will be invalid until TableUpdateLayout() or the first call to TableSetupColumn()
623
    if (table->ColumnsNames.Buf.Size > 0)
624
        table->ColumnsNames.Buf.resize(0);
625
626
    // Apply queued resizing/reordering/hiding requests
627
    TableBeginApplyRequests(table);
628
629
    return true;
630
}
631
632
// For reference, the average total _allocation count_ for a table is:
633
// + 0 (for ImGuiTable instance, we are pooling allocations in g.Tables[])
634
// + 1 (for table->RawData allocated below)
635
// + 1 (for table->ColumnsNames, if names are used)
636
// Shared allocations for the maximum number of simultaneously nested tables (generally a very small number)
637
// + 1 (for table->Splitter._Channels)
638
// + 2 * active_channels_count (for ImDrawCmd and ImDrawIdx buffers inside channels)
639
// Where active_channels_count is variable but often == columns_count or == columns_count + 1, see TableSetupDrawChannels() for details.
640
// Unused channels don't perform their +2 allocations.
641
void ImGui::TableBeginInitMemory(ImGuiTable* table, int columns_count)
642
{
643
    // Allocate single buffer for our arrays
644
    const int columns_bit_array_size = (int)ImBitArrayGetStorageSizeInBytes(columns_count);
645
    ImSpanAllocator<6> span_allocator;
646
    span_allocator.Reserve(0, columns_count * sizeof(ImGuiTableColumn));
647
    span_allocator.Reserve(1, columns_count * sizeof(ImGuiTableColumnIdx));
648
    span_allocator.Reserve(2, columns_count * sizeof(ImGuiTableCellData), 4);
649
    for (int n = 3; n < 6; n++)
650
        span_allocator.Reserve(n, columns_bit_array_size);
651
    table->RawData = IM_ALLOC(span_allocator.GetArenaSizeInBytes());
652
    memset(table->RawData, 0, span_allocator.GetArenaSizeInBytes());
653
    span_allocator.SetArenaBasePtr(table->RawData);
654
    span_allocator.GetSpan(0, &table->Columns);
655
    span_allocator.GetSpan(1, &table->DisplayOrderToIndex);
656
    span_allocator.GetSpan(2, &table->RowCellData);
657
    table->EnabledMaskByDisplayOrder = (ImU32*)span_allocator.GetSpanPtrBegin(3);
658
    table->EnabledMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(4);
659
    table->VisibleMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(5);
660
}
661
662
// Apply queued resizing/reordering/hiding requests
663
void ImGui::TableBeginApplyRequests(ImGuiTable* table)
664
{
665
    // Handle resizing request
666
    // (We process this in the TableBegin() of the first instance of each table)
667
    // FIXME-TABLE: Contains columns if our work area doesn't allow for scrolling?
668
    if (table->InstanceCurrent == 0)
669
    {
670
        if (table->ResizedColumn != -1 && table->ResizedColumnNextWidth != FLT_MAX)
671
            TableSetColumnWidth(table->ResizedColumn, table->ResizedColumnNextWidth);
672
        table->LastResizedColumn = table->ResizedColumn;
673
        table->ResizedColumnNextWidth = FLT_MAX;
674
        table->ResizedColumn = -1;
675
676
        // Process auto-fit for single column, which is a special case for stretch columns and fixed columns with FixedSame policy.
677
        // FIXME-TABLE: Would be nice to redistribute available stretch space accordingly to other weights, instead of giving it all to siblings.
678
        if (table->AutoFitSingleColumn != -1)
679
        {
680
            TableSetColumnWidth(table->AutoFitSingleColumn, table->Columns[table->AutoFitSingleColumn].WidthAuto);
681
            table->AutoFitSingleColumn = -1;
682
        }
683
    }
684
685
    // Handle reordering request
686
    // Note: we don't clear ReorderColumn after handling the request.
687
    if (table->InstanceCurrent == 0)
688
    {
689
        if (table->HeldHeaderColumn == -1 && table->ReorderColumn != -1)
690
            table->ReorderColumn = -1;
691
        table->HeldHeaderColumn = -1;
692
        if (table->ReorderColumn != -1 && table->ReorderColumnDir != 0)
693
        {
694
            // We need to handle reordering across hidden columns.
695
            // In the configuration below, moving C to the right of E will lead to:
696
            //    ... C [D] E  --->  ... [D] E  C   (Column name/index)
697
            //    ... 2  3  4        ...  2  3  4   (Display order)
698
            const int reorder_dir = table->ReorderColumnDir;
699
            IM_ASSERT(reorder_dir == -1 || reorder_dir == +1);
700
            IM_ASSERT(table->Flags & ImGuiTableFlags_Reorderable);
701
            ImGuiTableColumn* src_column = &table->Columns[table->ReorderColumn];
702
            ImGuiTableColumn* dst_column = &table->Columns[(reorder_dir == -1) ? src_column->PrevEnabledColumn : src_column->NextEnabledColumn];
703
            IM_UNUSED(dst_column);
704
            const int src_order = src_column->DisplayOrder;
705
            const int dst_order = dst_column->DisplayOrder;
706
            src_column->DisplayOrder = (ImGuiTableColumnIdx)dst_order;
707
            for (int order_n = src_order + reorder_dir; order_n != dst_order + reorder_dir; order_n += reorder_dir)
708
                table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder -= (ImGuiTableColumnIdx)reorder_dir;
709
            IM_ASSERT(dst_column->DisplayOrder == dst_order - reorder_dir);
710
711
            // Display order is stored in both columns->IndexDisplayOrder and table->DisplayOrder[]. Rebuild later from the former.
712
            for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
713
                table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n;
714
            table->ReorderColumnDir = 0;
715
            table->IsSettingsDirty = true;
716
        }
717
    }
718
719
    // Handle display order reset request
720
    if (table->IsResetDisplayOrderRequest)
721
    {
722
        for (int n = 0; n < table->ColumnsCount; n++)
723
            table->DisplayOrderToIndex[n] = table->Columns[n].DisplayOrder = (ImGuiTableColumnIdx)n;
724
        table->IsResetDisplayOrderRequest = false;
725
        table->IsSettingsDirty = true;
726
    }
727
}
728
729
// Adjust flags: default width mode + stretch columns are not allowed when auto extending
730
static void TableSetupColumnFlags(ImGuiTable* table, ImGuiTableColumn* column, ImGuiTableColumnFlags flags_in)
731
{
732
    ImGuiTableColumnFlags flags = flags_in;
733
734
    // Sizing Policy
735
    if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0)
736
    {
737
        const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_);
738
        if (table_sizing_policy == ImGuiTableFlags_SizingFixedFit || table_sizing_policy == ImGuiTableFlags_SizingFixedSame)
739
            flags |= ImGuiTableColumnFlags_WidthFixed;
740
        else
741
            flags |= ImGuiTableColumnFlags_WidthStretch;
742
    }
743
    else
744
    {
745
        IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_WidthMask_)); // Check that only 1 of each set is used.
746
    }
747
748
    // Resize
749
    if ((table->Flags & ImGuiTableFlags_Resizable) == 0)
750
        flags |= ImGuiTableColumnFlags_NoResize;
751
752
    // Sorting
753
    if ((flags & ImGuiTableColumnFlags_NoSortAscending) && (flags & ImGuiTableColumnFlags_NoSortDescending))
754
        flags |= ImGuiTableColumnFlags_NoSort;
755
756
    // Indentation
757
    if ((flags & ImGuiTableColumnFlags_IndentMask_) == 0)
758
        flags |= (table->Columns.index_from_ptr(column) == 0) ? ImGuiTableColumnFlags_IndentEnable : ImGuiTableColumnFlags_IndentDisable;
759
760
    // Alignment
761
    //if ((flags & ImGuiTableColumnFlags_AlignMask_) == 0)
762
    //    flags |= ImGuiTableColumnFlags_AlignCenter;
763
    //IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_AlignMask_)); // Check that only 1 of each set is used.
764
765
    // Preserve status flags
766
    column->Flags = flags | (column->Flags & ImGuiTableColumnFlags_StatusMask_);
767
768
    // Build an ordered list of available sort directions
769
    column->SortDirectionsAvailCount = column->SortDirectionsAvailMask = column->SortDirectionsAvailList = 0;
770
    if (table->Flags & ImGuiTableFlags_Sortable)
771
    {
772
        int count = 0, mask = 0, list = 0;
773
        if ((flags & ImGuiTableColumnFlags_PreferSortAscending)  != 0 && (flags & ImGuiTableColumnFlags_NoSortAscending)  == 0) { mask |= 1 << ImGuiSortDirection_Ascending;  list |= ImGuiSortDirection_Ascending  << (count << 1); count++; }
774
        if ((flags & ImGuiTableColumnFlags_PreferSortDescending) != 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; }
775
        if ((flags & ImGuiTableColumnFlags_PreferSortAscending)  == 0 && (flags & ImGuiTableColumnFlags_NoSortAscending)  == 0) { mask |= 1 << ImGuiSortDirection_Ascending;  list |= ImGuiSortDirection_Ascending  << (count << 1); count++; }
776
        if ((flags & ImGuiTableColumnFlags_PreferSortDescending) == 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; }
777
        if ((table->Flags & ImGuiTableFlags_SortTristate) || count == 0) { mask |= 1 << ImGuiSortDirection_None; count++; }
778
        column->SortDirectionsAvailList = (ImU8)list;
779
        column->SortDirectionsAvailMask = (ImU8)mask;
780
        column->SortDirectionsAvailCount = (ImU8)count;
781
        ImGui::TableFixColumnSortDirection(table, column);
782
    }
783
}
784
785
// Layout columns for the frame. This is in essence the followup to BeginTable() and this is our largest function.
786
// Runs on the first call to TableNextRow(), to give a chance for TableSetupColumn() and other TableSetupXXXXX() functions to be called first.
787
// FIXME-TABLE: Our width (and therefore our WorkRect) will be minimal in the first frame for _WidthAuto columns.
788
// Increase feedback side-effect with widgets relying on WorkRect.Max.x... Maybe provide a default distribution for _WidthAuto columns?
789
void ImGui::TableUpdateLayout(ImGuiTable* table)
790
{
791
    ImGuiContext& g = *GImGui;
792
    IM_ASSERT(table->IsLayoutLocked == false);
793
794
    const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_);
795
    table->IsDefaultDisplayOrder = true;
796
    table->ColumnsEnabledCount = 0;
797
    ImBitArrayClearAllBits(table->EnabledMaskByIndex, table->ColumnsCount);
798
    ImBitArrayClearAllBits(table->EnabledMaskByDisplayOrder, table->ColumnsCount);
799
    table->LeftMostEnabledColumn = -1;
800
    table->MinColumnWidth = ImMax(1.0f, g.Style.FramePadding.x * 1.0f); // g.Style.ColumnsMinSpacing; // FIXME-TABLE
801
802
    // [Part 1] Apply/lock Enabled and Order states. Calculate auto/ideal width for columns. Count fixed/stretch columns.
803
    // Process columns in their visible orders as we are building the Prev/Next indices.
804
    int count_fixed = 0;                // Number of columns that have fixed sizing policies
805
    int count_stretch = 0;              // Number of columns that have stretch sizing policies
806
    int prev_visible_column_idx = -1;
807
    bool has_auto_fit_request = false;
808
    bool has_resizable = false;
809
    float stretch_sum_width_auto = 0.0f;
810
    float fixed_max_width_auto = 0.0f;
811
    for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
812
    {
813
        const int column_n = table->DisplayOrderToIndex[order_n];
814
        if (column_n != order_n)
815
            table->IsDefaultDisplayOrder = false;
816
        ImGuiTableColumn* column = &table->Columns[column_n];
817
818
        // Clear column setup if not submitted by user. Currently we make it mandatory to call TableSetupColumn() every frame.
819
        // It would easily work without but we're not ready to guarantee it since e.g. names need resubmission anyway.
820
        // We take a slight shortcut but in theory we could be calling TableSetupColumn() here with dummy values, it should yield the same effect.
821
        if (table->DeclColumnsCount <= column_n)
822
        {
823
            TableSetupColumnFlags(table, column, ImGuiTableColumnFlags_None);
824
            column->NameOffset = -1;
825
            column->UserID = 0;
826
            column->InitStretchWeightOrWidth = -1.0f;
827
        }
828
829
        // Update Enabled state, mark settings and sort specs dirty
830
        if (!(table->Flags & ImGuiTableFlags_Hideable) || (column->Flags & ImGuiTableColumnFlags_NoHide))
831
            column->IsUserEnabledNextFrame = true;
832
        if (column->IsUserEnabled != column->IsUserEnabledNextFrame)
833
        {
834
            column->IsUserEnabled = column->IsUserEnabledNextFrame;
835
            table->IsSettingsDirty = true;
836
        }
837
        column->IsEnabled = column->IsUserEnabled && (column->Flags & ImGuiTableColumnFlags_Disabled) == 0;
838
839
        if (column->SortOrder != -1 && !column->IsEnabled)
840
            table->IsSortSpecsDirty = true;
841
        if (column->SortOrder > 0 && !(table->Flags & ImGuiTableFlags_SortMulti))
842
            table->IsSortSpecsDirty = true;
843
844
        // Auto-fit unsized columns
845
        const bool start_auto_fit = (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? (column->WidthRequest < 0.0f) : (column->StretchWeight < 0.0f);
846
        if (start_auto_fit)
847
            column->AutoFitQueue = column->CannotSkipItemsQueue = (1 << 3) - 1; // Fit for three frames
848
849
        if (!column->IsEnabled)
850
        {
851
            column->IndexWithinEnabledSet = -1;
852
            continue;
853
        }
854
855
        // Mark as enabled and link to previous/next enabled column
856
        column->PrevEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx;
857
        column->NextEnabledColumn = -1;
858
        if (prev_visible_column_idx != -1)
859
            table->Columns[prev_visible_column_idx].NextEnabledColumn = (ImGuiTableColumnIdx)column_n;
860
        else
861
            table->LeftMostEnabledColumn = (ImGuiTableColumnIdx)column_n;
862
        column->IndexWithinEnabledSet = table->ColumnsEnabledCount++;
863
        ImBitArraySetBit(table->EnabledMaskByIndex, column_n);
864
        ImBitArraySetBit(table->EnabledMaskByDisplayOrder, column->DisplayOrder);
865
        prev_visible_column_idx = column_n;
866
        IM_ASSERT(column->IndexWithinEnabledSet <= column->DisplayOrder);
867
868
        // Calculate ideal/auto column width (that's the width required for all contents to be visible without clipping)
869
        // Combine width from regular rows + width from headers unless requested not to.
870
        if (!column->IsPreserveWidthAuto && table->InstanceCurrent == 0)
871
            column->WidthAuto = TableGetColumnWidthAuto(table, column);
872
873
        // Non-resizable columns keep their requested width (apply user value regardless of IsPreserveWidthAuto)
874
        const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0;
875
        if (column_is_resizable)
876
            has_resizable = true;
877
        if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f && !column_is_resizable)
878
            column->WidthAuto = column->InitStretchWeightOrWidth;
879
880
        if (column->AutoFitQueue != 0x00)
881
            has_auto_fit_request = true;
882
        if (column->Flags & ImGuiTableColumnFlags_WidthStretch)
883
        {
884
            stretch_sum_width_auto += column->WidthAuto;
885
            count_stretch++;
886
        }
887
        else
888
        {
889
            fixed_max_width_auto = ImMax(fixed_max_width_auto, column->WidthAuto);
890
            count_fixed++;
891
        }
892
    }
893
    if ((table->Flags & ImGuiTableFlags_Sortable) && table->SortSpecsCount == 0 && !(table->Flags & ImGuiTableFlags_SortTristate))
894
        table->IsSortSpecsDirty = true;
895
    table->RightMostEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx;
896
    IM_ASSERT(table->LeftMostEnabledColumn >= 0 && table->RightMostEnabledColumn >= 0);
897
898
    // [Part 2] Disable child window clipping while fitting columns. This is not strictly necessary but makes it possible to avoid
899
    // the column fitting having to wait until the first visible frame of the child container (may or not be a good thing). Also see #6510.
900
    // FIXME-TABLE: for always auto-resizing columns may not want to do that all the time.
901
    if (has_auto_fit_request && table->OuterWindow != table->InnerWindow)
902
        table->InnerWindow->SkipItems = false;
903
    if (has_auto_fit_request)
904
        table->IsSettingsDirty = true;
905
906
    // [Part 3] Fix column flags and record a few extra information.
907
    float sum_width_requests = 0.0f;    // Sum of all width for fixed and auto-resize columns, excluding width contributed by Stretch columns but including spacing/padding.
908
    float stretch_sum_weights = 0.0f;   // Sum of all weights for stretch columns.
909
    table->LeftMostStretchedColumn = table->RightMostStretchedColumn = -1;
910
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
911
    {
912
        if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
913
            continue;
914
        ImGuiTableColumn* column = &table->Columns[column_n];
915
916
        const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0;
917
        if (column->Flags & ImGuiTableColumnFlags_WidthFixed)
918
        {
919
            // Apply same widths policy
920
            float width_auto = column->WidthAuto;
921
            if (table_sizing_policy == ImGuiTableFlags_SizingFixedSame && (column->AutoFitQueue != 0x00 || !column_is_resizable))
922
                width_auto = fixed_max_width_auto;
923
924
            // Apply automatic width
925
            // Latch initial size for fixed columns and update it constantly for auto-resizing column (unless clipped!)
926
            if (column->AutoFitQueue != 0x00)
927
                column->WidthRequest = width_auto;
928
            else if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !column_is_resizable && column->IsRequestOutput)
929
                column->WidthRequest = width_auto;
930
931
            // FIXME-TABLE: Increase minimum size during init frame to avoid biasing auto-fitting widgets
932
            // (e.g. TextWrapped) too much. Otherwise what tends to happen is that TextWrapped would output a very
933
            // large height (= first frame scrollbar display very off + clipper would skip lots of items).
934
            // This is merely making the side-effect less extreme, but doesn't properly fixes it.
935
            // FIXME: Move this to ->WidthGiven to avoid temporary lossyless?
936
            // FIXME: This break IsPreserveWidthAuto from not flickering if the stored WidthAuto was smaller.
937
            if (column->AutoFitQueue > 0x01 && table->IsInitializing && !column->IsPreserveWidthAuto)
938
                column->WidthRequest = ImMax(column->WidthRequest, table->MinColumnWidth * 4.0f); // FIXME-TABLE: Another constant/scale?
939
            sum_width_requests += column->WidthRequest;
940
        }
941
        else
942
        {
943
            // Initialize stretch weight
944
            if (column->AutoFitQueue != 0x00 || column->StretchWeight < 0.0f || !column_is_resizable)
945
            {
946
                if (column->InitStretchWeightOrWidth > 0.0f)
947
                    column->StretchWeight = column->InitStretchWeightOrWidth;
948
                else if (table_sizing_policy == ImGuiTableFlags_SizingStretchProp)
949
                    column->StretchWeight = (column->WidthAuto / stretch_sum_width_auto) * count_stretch;
950
                else
951
                    column->StretchWeight = 1.0f;
952
            }
953
954
            stretch_sum_weights += column->StretchWeight;
955
            if (table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder > column->DisplayOrder)
956
                table->LeftMostStretchedColumn = (ImGuiTableColumnIdx)column_n;
957
            if (table->RightMostStretchedColumn == -1 || table->Columns[table->RightMostStretchedColumn].DisplayOrder < column->DisplayOrder)
958
                table->RightMostStretchedColumn = (ImGuiTableColumnIdx)column_n;
959
        }
960
        column->IsPreserveWidthAuto = false;
961
        sum_width_requests += table->CellPaddingX * 2.0f;
962
    }
963
    table->ColumnsEnabledFixedCount = (ImGuiTableColumnIdx)count_fixed;
964
    table->ColumnsStretchSumWeights = stretch_sum_weights;
965
966
    // [Part 4] Apply final widths based on requested widths
967
    const ImRect work_rect = table->WorkRect;
968
    const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1);
969
    const float width_removed = (table->HasScrollbarYPrev && !table->InnerWindow->ScrollbarY) ? g.Style.ScrollbarSize : 0.0f; // To synchronize decoration width of synched tables with mismatching scrollbar state (#5920)
970
    const float width_avail = ImMax(1.0f, (((table->Flags & ImGuiTableFlags_ScrollX) && table->InnerWidth == 0.0f) ? table->InnerClipRect.GetWidth() : work_rect.GetWidth()) - width_removed);
971
    const float width_avail_for_stretched_columns = width_avail - width_spacings - sum_width_requests;
972
    float width_remaining_for_stretched_columns = width_avail_for_stretched_columns;
973
    table->ColumnsGivenWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount;
974
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
975
    {
976
        if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
977
            continue;
978
        ImGuiTableColumn* column = &table->Columns[column_n];
979
980
        // Allocate width for stretched/weighted columns (StretchWeight gets converted into WidthRequest)
981
        if (column->Flags & ImGuiTableColumnFlags_WidthStretch)
982
        {
983
            float weight_ratio = column->StretchWeight / stretch_sum_weights;
984
            column->WidthRequest = IM_TRUNC(ImMax(width_avail_for_stretched_columns * weight_ratio, table->MinColumnWidth) + 0.01f);
985
            width_remaining_for_stretched_columns -= column->WidthRequest;
986
        }
987
988
        // [Resize Rule 1] The right-most Visible column is not resizable if there is at least one Stretch column
989
        // See additional comments in TableSetColumnWidth().
990
        if (column->NextEnabledColumn == -1 && table->LeftMostStretchedColumn != -1)
991
            column->Flags |= ImGuiTableColumnFlags_NoDirectResize_;
992
993
        // Assign final width, record width in case we will need to shrink
994
        column->WidthGiven = ImTrunc(ImMax(column->WidthRequest, table->MinColumnWidth));
995
        table->ColumnsGivenWidth += column->WidthGiven;
996
    }
997
998
    // [Part 5] Redistribute stretch remainder width due to rounding (remainder width is < 1.0f * number of Stretch column).
999
    // Using right-to-left distribution (more likely to match resizing cursor).
1000
    if (width_remaining_for_stretched_columns >= 1.0f && !(table->Flags & ImGuiTableFlags_PreciseWidths))
1001
        for (int order_n = table->ColumnsCount - 1; stretch_sum_weights > 0.0f && width_remaining_for_stretched_columns >= 1.0f && order_n >= 0; order_n--)
1002
        {
1003
            if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
1004
                continue;
1005
            ImGuiTableColumn* column = &table->Columns[table->DisplayOrderToIndex[order_n]];
1006
            if (!(column->Flags & ImGuiTableColumnFlags_WidthStretch))
1007
                continue;
1008
            column->WidthRequest += 1.0f;
1009
            column->WidthGiven += 1.0f;
1010
            width_remaining_for_stretched_columns -= 1.0f;
1011
        }
1012
1013
    // Determine if table is hovered which will be used to flag columns as hovered.
1014
    // - In principle we'd like to use the equivalent of IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem),
1015
    //   but because our item is partially submitted at this point we use ItemHoverable() and a workaround (temporarily
1016
    //   clear ActiveId, which is equivalent to the change provided by _AllowWhenBLockedByActiveItem).
1017
    // - This allows columns to be marked as hovered when e.g. clicking a button inside the column, or using drag and drop.
1018
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1019
    table_instance->HoveredRowLast = table_instance->HoveredRowNext;
1020
    table_instance->HoveredRowNext = -1;
1021
    table->HoveredColumnBody = table->HoveredColumnBorder = -1;
1022
    const ImRect mouse_hit_rect(table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.Max.x, ImMax(table->OuterRect.Max.y, table->OuterRect.Min.y + table_instance->LastOuterHeight));
1023
    const ImGuiID backup_active_id = g.ActiveId;
1024
    g.ActiveId = 0;
1025
    const bool is_hovering_table = ItemHoverable(mouse_hit_rect, 0, ImGuiItemFlags_None);
1026
    g.ActiveId = backup_active_id;
1027
1028
    // Determine skewed MousePos.x to support angled headers.
1029
    float mouse_skewed_x = g.IO.MousePos.x;
1030
    if (table->AngledHeadersHeight > 0.0f)
1031
        if (g.IO.MousePos.y >= table->OuterRect.Min.y && g.IO.MousePos.y <= table->OuterRect.Min.y + table->AngledHeadersHeight)
1032
            mouse_skewed_x += ImTrunc((table->OuterRect.Min.y + table->AngledHeadersHeight - g.IO.MousePos.y) * table->AngledHeadersSlope);
1033
1034
    // [Part 6] Setup final position, offset, skip/clip states and clipping rectangles, detect hovered column
1035
    // Process columns in their visible orders as we are comparing the visible order and adjusting host_clip_rect while looping.
1036
    int visible_n = 0;
1037
    bool has_at_least_one_column_requesting_output = false;
1038
    bool offset_x_frozen = (table->FreezeColumnsCount > 0);
1039
    float offset_x = ((table->FreezeColumnsCount > 0) ? table->OuterRect.Min.x : work_rect.Min.x) + table->OuterPaddingX - table->CellSpacingX1;
1040
    ImRect host_clip_rect = table->InnerClipRect;
1041
    //host_clip_rect.Max.x += table->CellPaddingX + table->CellSpacingX2;
1042
    ImBitArrayClearAllBits(table->VisibleMaskByIndex, table->ColumnsCount);
1043
    for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
1044
    {
1045
        const int column_n = table->DisplayOrderToIndex[order_n];
1046
        ImGuiTableColumn* column = &table->Columns[column_n];
1047
1048
        column->NavLayerCurrent = (ImS8)(table->FreezeRowsCount > 0 ? ImGuiNavLayer_Menu : ImGuiNavLayer_Main); // Use Count NOT request so Header line changes layer when frozen
1049
1050
        if (offset_x_frozen && table->FreezeColumnsCount == visible_n)
1051
        {
1052
            offset_x += work_rect.Min.x - table->OuterRect.Min.x;
1053
            offset_x_frozen = false;
1054
        }
1055
1056
        // Clear status flags
1057
        column->Flags &= ~ImGuiTableColumnFlags_StatusMask_;
1058
1059
        if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
1060
        {
1061
            // Hidden column: clear a few fields and we are done with it for the remainder of the function.
1062
            // We set a zero-width clip rect but set Min.y/Max.y properly to not interfere with the clipper.
1063
            column->MinX = column->MaxX = column->WorkMinX = column->ClipRect.Min.x = column->ClipRect.Max.x = offset_x;
1064
            column->WidthGiven = 0.0f;
1065
            column->ClipRect.Min.y = work_rect.Min.y;
1066
            column->ClipRect.Max.y = FLT_MAX;
1067
            column->ClipRect.ClipWithFull(host_clip_rect);
1068
            column->IsVisibleX = column->IsVisibleY = column->IsRequestOutput = false;
1069
            column->IsSkipItems = true;
1070
            column->ItemWidth = 1.0f;
1071
            continue;
1072
        }
1073
1074
        // Lock start position
1075
        column->MinX = offset_x;
1076
1077
        // Lock width based on start position and minimum/maximum width for this position
1078
        column->WidthMax = TableCalcMaxColumnWidth(table, column_n);
1079
        column->WidthGiven = ImMin(column->WidthGiven, column->WidthMax);
1080
        column->WidthGiven = ImMax(column->WidthGiven, ImMin(column->WidthRequest, table->MinColumnWidth));
1081
        column->MaxX = offset_x + column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f;
1082
1083
        // Lock other positions
1084
        // - ClipRect.Min.x: Because merging draw commands doesn't compare min boundaries, we make ClipRect.Min.x match left bounds to be consistent regardless of merging.
1085
        // - ClipRect.Max.x: using WorkMaxX instead of MaxX (aka including padding) makes things more consistent when resizing down, tho slightly detrimental to visibility in very-small column.
1086
        // - ClipRect.Max.x: using MaxX makes it easier for header to receive hover highlight with no discontinuity and display sorting arrow.
1087
        // - FIXME-TABLE: We want equal width columns to have equal (ClipRect.Max.x - WorkMinX) width, which means ClipRect.max.x cannot stray off host_clip_rect.Max.x else right-most column may appear shorter.
1088
        const float previous_instance_work_min_x = column->WorkMinX;
1089
        column->WorkMinX = column->MinX + table->CellPaddingX + table->CellSpacingX1;
1090
        column->WorkMaxX = column->MaxX - table->CellPaddingX - table->CellSpacingX2; // Expected max
1091
        column->ItemWidth = ImTrunc(column->WidthGiven * 0.65f);
1092
        column->ClipRect.Min.x = column->MinX;
1093
        column->ClipRect.Min.y = work_rect.Min.y;
1094
        column->ClipRect.Max.x = column->MaxX; //column->WorkMaxX;
1095
        column->ClipRect.Max.y = FLT_MAX;
1096
        column->ClipRect.ClipWithFull(host_clip_rect);
1097
1098
        // Mark column as Clipped (not in sight)
1099
        // Note that scrolling tables (where inner_window != outer_window) handle Y clipped earlier in BeginTable() so IsVisibleY really only applies to non-scrolling tables.
1100
        // FIXME-TABLE: Because InnerClipRect.Max.y is conservatively ==outer_window->ClipRect.Max.y, we never can mark columns _Above_ the scroll line as not IsVisibleY.
1101
        // Taking advantage of LastOuterHeight would yield good results there...
1102
        // FIXME-TABLE: Y clipping is disabled because it effectively means not submitting will reduce contents width which is fed to outer_window->DC.CursorMaxPos.x,
1103
        // and this may be used (e.g. typically by outer_window using AlwaysAutoResize or outer_window's horizontal scrollbar, but could be something else).
1104
        // Possible solution to preserve last known content width for clipped column. Test 'table_reported_size' fails when enabling Y clipping and window is resized small.
1105
        column->IsVisibleX = (column->ClipRect.Max.x > column->ClipRect.Min.x);
1106
        column->IsVisibleY = true; // (column->ClipRect.Max.y > column->ClipRect.Min.y);
1107
        const bool is_visible = column->IsVisibleX; //&& column->IsVisibleY;
1108
        if (is_visible)
1109
            ImBitArraySetBit(table->VisibleMaskByIndex, column_n);
1110
1111
        // Mark column as requesting output from user. Note that fixed + non-resizable sets are auto-fitting at all times and therefore always request output.
1112
        column->IsRequestOutput = is_visible || column->AutoFitQueue != 0 || column->CannotSkipItemsQueue != 0;
1113
1114
        // Mark column as SkipItems (ignoring all items/layout)
1115
        // (table->HostSkipItems is a copy of inner_window->SkipItems before we cleared it above in Part 2)
1116
        column->IsSkipItems = !column->IsEnabled || table->HostSkipItems;
1117
        if (column->IsSkipItems)
1118
            IM_ASSERT(!is_visible);
1119
        if (column->IsRequestOutput && !column->IsSkipItems)
1120
            has_at_least_one_column_requesting_output = true;
1121
1122
        // Update status flags
1123
        column->Flags |= ImGuiTableColumnFlags_IsEnabled;
1124
        if (is_visible)
1125
            column->Flags |= ImGuiTableColumnFlags_IsVisible;
1126
        if (column->SortOrder != -1)
1127
            column->Flags |= ImGuiTableColumnFlags_IsSorted;
1128
1129
        // Detect hovered column
1130
        if (is_hovering_table && mouse_skewed_x >= column->ClipRect.Min.x && mouse_skewed_x < column->ClipRect.Max.x)
1131
        {
1132
            column->Flags |= ImGuiTableColumnFlags_IsHovered;
1133
            table->HoveredColumnBody = (ImGuiTableColumnIdx)column_n;
1134
        }
1135
1136
        // Alignment
1137
        // FIXME-TABLE: This align based on the whole column width, not per-cell, and therefore isn't useful in
1138
        // many cases (to be able to honor this we might be able to store a log of cells width, per row, for
1139
        // visible rows, but nav/programmatic scroll would have visible artifacts.)
1140
        //if (column->Flags & ImGuiTableColumnFlags_AlignRight)
1141
        //    column->WorkMinX = ImMax(column->WorkMinX, column->MaxX - column->ContentWidthRowsUnfrozen);
1142
        //else if (column->Flags & ImGuiTableColumnFlags_AlignCenter)
1143
        //    column->WorkMinX = ImLerp(column->WorkMinX, ImMax(column->StartX, column->MaxX - column->ContentWidthRowsUnfrozen), 0.5f);
1144
1145
        // Reset content width variables
1146
        if (table->InstanceCurrent == 0)
1147
        {
1148
            column->ContentMaxXFrozen = column->WorkMinX;
1149
            column->ContentMaxXUnfrozen = column->WorkMinX;
1150
            column->ContentMaxXHeadersUsed = column->WorkMinX;
1151
            column->ContentMaxXHeadersIdeal = column->WorkMinX;
1152
        }
1153
        else
1154
        {
1155
            // As we store an absolute value to make per-cell updates faster, we need to offset values used for width computation.
1156
            const float offset_from_previous_instance = column->WorkMinX - previous_instance_work_min_x;
1157
            column->ContentMaxXFrozen += offset_from_previous_instance;
1158
            column->ContentMaxXUnfrozen += offset_from_previous_instance;
1159
            column->ContentMaxXHeadersUsed += offset_from_previous_instance;
1160
            column->ContentMaxXHeadersIdeal += offset_from_previous_instance;
1161
        }
1162
1163
        // Don't decrement auto-fit counters until container window got a chance to submit its items
1164
        if (table->HostSkipItems == false && table->InstanceCurrent == 0)
1165
        {
1166
            column->AutoFitQueue >>= 1;
1167
            column->CannotSkipItemsQueue >>= 1;
1168
        }
1169
1170
        if (visible_n < table->FreezeColumnsCount)
1171
            host_clip_rect.Min.x = ImClamp(column->MaxX + TABLE_BORDER_SIZE, host_clip_rect.Min.x, host_clip_rect.Max.x);
1172
1173
        offset_x += column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f;
1174
        visible_n++;
1175
    }
1176
1177
    // In case the table is visible (e.g. decorations) but all columns clipped, we keep a column visible.
1178
    // Else if give no chance to a clipper-savy user to submit rows and therefore total contents height used by scrollbar.
1179
    if (has_at_least_one_column_requesting_output == false)
1180
    {
1181
        table->Columns[table->LeftMostEnabledColumn].IsRequestOutput = true;
1182
        table->Columns[table->LeftMostEnabledColumn].IsSkipItems = false;
1183
    }
1184
1185
    // [Part 7] Detect/store when we are hovering the unused space after the right-most column (so e.g. context menus can react on it)
1186
    // Clear Resizable flag if none of our column are actually resizable (either via an explicit _NoResize flag, either
1187
    // because of using _WidthAuto/_WidthStretch). This will hide the resizing option from the context menu.
1188
    const float unused_x1 = ImMax(table->WorkRect.Min.x, table->Columns[table->RightMostEnabledColumn].ClipRect.Max.x);
1189
    if (is_hovering_table && table->HoveredColumnBody == -1)
1190
        if (mouse_skewed_x >= unused_x1)
1191
            table->HoveredColumnBody = (ImGuiTableColumnIdx)table->ColumnsCount;
1192
    if (has_resizable == false && (table->Flags & ImGuiTableFlags_Resizable))
1193
        table->Flags &= ~ImGuiTableFlags_Resizable;
1194
1195
    table->IsActiveIdAliveBeforeTable = (g.ActiveIdIsAlive != 0);
1196
1197
    // [Part 8] Lock actual OuterRect/WorkRect right-most position.
1198
    // This is done late to handle the case of fixed-columns tables not claiming more widths that they need.
1199
    // Because of this we are careful with uses of WorkRect and InnerClipRect before this point.
1200
    if (table->RightMostStretchedColumn != -1)
1201
        table->Flags &= ~ImGuiTableFlags_NoHostExtendX;
1202
    if (table->Flags & ImGuiTableFlags_NoHostExtendX)
1203
    {
1204
        table->OuterRect.Max.x = table->WorkRect.Max.x = unused_x1;
1205
        table->InnerClipRect.Max.x = ImMin(table->InnerClipRect.Max.x, unused_x1);
1206
    }
1207
    table->InnerWindow->ParentWorkRect = table->WorkRect;
1208
    table->BorderX1 = table->InnerClipRect.Min.x;
1209
    table->BorderX2 = table->InnerClipRect.Max.x;
1210
1211
    // Setup window's WorkRect.Max.y for GetContentRegionAvail(). Other values will be updated in each TableBeginCell() call.
1212
    float window_content_max_y;
1213
    if (table->Flags & ImGuiTableFlags_NoHostExtendY)
1214
        window_content_max_y = table->OuterRect.Max.y;
1215
    else
1216
        window_content_max_y = ImMax(table->InnerWindow->ContentRegionRect.Max.y, (table->Flags & ImGuiTableFlags_ScrollY) ? 0.0f : table->OuterRect.Max.y);
1217
    table->InnerWindow->WorkRect.Max.y = ImClamp(window_content_max_y - g.Style.CellPadding.y, table->InnerWindow->WorkRect.Min.y, table->InnerWindow->WorkRect.Max.y);
1218
1219
    // [Part 9] Allocate draw channels and setup background cliprect
1220
    TableSetupDrawChannels(table);
1221
1222
    // [Part 10] Hit testing on borders
1223
    if (table->Flags & ImGuiTableFlags_Resizable)
1224
        TableUpdateBorders(table);
1225
    table_instance->LastTopHeadersRowHeight = 0.0f;
1226
    table->IsLayoutLocked = true;
1227
    table->IsUsingHeaders = false;
1228
1229
    // Highlight header
1230
    table->HighlightColumnHeader = -1;
1231
    if (table->IsContextPopupOpen && table->ContextPopupColumn != -1 && table->InstanceInteracted == table->InstanceCurrent)
1232
        table->HighlightColumnHeader = table->ContextPopupColumn;
1233
    else if ((table->Flags & ImGuiTableFlags_HighlightHoveredColumn) && table->HoveredColumnBody != -1 && table->HoveredColumnBody != table->ColumnsCount && table->HoveredColumnBorder == -1)
1234
        if (g.ActiveId == 0 || (table->IsActiveIdInTable || g.DragDropActive))
1235
            table->HighlightColumnHeader = table->HoveredColumnBody;
1236
1237
    // [Part 11] Default context menu
1238
    // - To append to this menu: you can call TableBeginContextMenuPopup()/.../EndPopup().
1239
    // - To modify or replace this: set table->IsContextPopupNoDefaultContents = true, then call TableBeginContextMenuPopup()/.../EndPopup().
1240
    // - You may call TableDrawDefaultContextMenu() with selected flags to display specific sections of the default menu,
1241
    //   e.g. TableDrawDefaultContextMenu(table, table->Flags & ~ImGuiTableFlags_Hideable) will display everything EXCEPT columns visibility options.
1242
    if (table->DisableDefaultContextMenu == false && TableBeginContextMenuPopup(table))
1243
    {
1244
        TableDrawDefaultContextMenu(table, table->Flags);
1245
        EndPopup();
1246
    }
1247
1248
    // [Part 12] Sanitize and build sort specs before we have a chance to use them for display.
1249
    // This path will only be exercised when sort specs are modified before header rows (e.g. init or visibility change)
1250
    if (table->IsSortSpecsDirty && (table->Flags & ImGuiTableFlags_Sortable))
1251
        TableSortSpecsBuild(table);
1252
1253
    // [Part 13] Setup inner window decoration size (for scrolling / nav tracking to properly take account of frozen rows/columns)
1254
    if (table->FreezeColumnsRequest > 0)
1255
        table->InnerWindow->DecoInnerSizeX1 = table->Columns[table->DisplayOrderToIndex[table->FreezeColumnsRequest - 1]].MaxX - table->OuterRect.Min.x;
1256
    if (table->FreezeRowsRequest > 0)
1257
        table->InnerWindow->DecoInnerSizeY1 = table_instance->LastFrozenHeight;
1258
    table_instance->LastFrozenHeight = 0.0f;
1259
1260
    // Initial state
1261
    ImGuiWindow* inner_window = table->InnerWindow;
1262
    if (table->Flags & ImGuiTableFlags_NoClip)
1263
        table->DrawSplitter->SetCurrentChannel(inner_window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP);
1264
    else
1265
        inner_window->DrawList->PushClipRect(inner_window->InnerClipRect.Min, inner_window->InnerClipRect.Max, false); // FIXME: use table->InnerClipRect?
1266
}
1267
1268
// Process hit-testing on resizing borders. Actual size change will be applied in EndTable()
1269
// - Set table->HoveredColumnBorder with a short delay/timer to reduce visual feedback noise.
1270
void ImGui::TableUpdateBorders(ImGuiTable* table)
1271
{
1272
    ImGuiContext& g = *GImGui;
1273
    IM_ASSERT(table->Flags & ImGuiTableFlags_Resizable);
1274
1275
    // At this point OuterRect height may be zero or under actual final height, so we rely on temporal coherency and
1276
    // use the final height from last frame. Because this is only affecting _interaction_ with columns, it is not
1277
    // really problematic (whereas the actual visual will be displayed in EndTable() and using the current frame height).
1278
    // Actual columns highlight/render will be performed in EndTable() and not be affected.
1279
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1280
    const float hit_half_width = ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale);
1281
    const float hit_y1 = (table->FreezeRowsCount >= 1 ? table->OuterRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight;
1282
    const float hit_y2_body = ImMax(table->OuterRect.Max.y, hit_y1 + table_instance->LastOuterHeight - table->AngledHeadersHeight);
1283
    const float hit_y2_head = hit_y1 + table_instance->LastTopHeadersRowHeight;
1284
1285
    for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
1286
    {
1287
        if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
1288
            continue;
1289
1290
        const int column_n = table->DisplayOrderToIndex[order_n];
1291
        ImGuiTableColumn* column = &table->Columns[column_n];
1292
        if (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_))
1293
            continue;
1294
1295
        // ImGuiTableFlags_NoBordersInBodyUntilResize will be honored in TableDrawBorders()
1296
        const float border_y2_hit = (table->Flags & ImGuiTableFlags_NoBordersInBody) ? hit_y2_head : hit_y2_body;
1297
        if ((table->Flags & ImGuiTableFlags_NoBordersInBody) && table->IsUsingHeaders == false)
1298
            continue;
1299
1300
        if (!column->IsVisibleX && table->LastResizedColumn != column_n)
1301
            continue;
1302
1303
        ImGuiID column_id = TableGetColumnResizeID(table, column_n, table->InstanceCurrent);
1304
        ImRect hit_rect(column->MaxX - hit_half_width, hit_y1, column->MaxX + hit_half_width, border_y2_hit);
1305
        ItemAdd(hit_rect, column_id, NULL, ImGuiItemFlags_NoNav);
1306
        //GetForegroundDrawList()->AddRect(hit_rect.Min, hit_rect.Max, IM_COL32(255, 0, 0, 100));
1307
1308
        bool hovered = false, held = false;
1309
        bool pressed = ButtonBehavior(hit_rect, column_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick | ImGuiButtonFlags_NoNavFocus);
1310
        if (pressed && IsMouseDoubleClicked(0))
1311
        {
1312
            TableSetColumnWidthAutoSingle(table, column_n);
1313
            ClearActiveID();
1314
            held = false;
1315
        }
1316
        if (held)
1317
        {
1318
            if (table->LastResizedColumn == -1)
1319
                table->ResizeLockMinContentsX2 = table->RightMostEnabledColumn != -1 ? table->Columns[table->RightMostEnabledColumn].MaxX : -FLT_MAX;
1320
            table->ResizedColumn = (ImGuiTableColumnIdx)column_n;
1321
            table->InstanceInteracted = table->InstanceCurrent;
1322
        }
1323
        if ((hovered && g.HoveredIdTimer > TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER) || held)
1324
        {
1325
            table->HoveredColumnBorder = (ImGuiTableColumnIdx)column_n;
1326
            SetMouseCursor(ImGuiMouseCursor_ResizeEW);
1327
        }
1328
    }
1329
}
1330
1331
void    ImGui::EndTable()
1332
{
1333
    ImGuiContext& g = *GImGui;
1334
    ImGuiTable* table = g.CurrentTable;
1335
    IM_ASSERT(table != NULL && "Only call EndTable() if BeginTable() returns true!");
1336
1337
    // This assert would be very useful to catch a common error... unfortunately it would probably trigger in some
1338
    // cases, and for consistency user may sometimes output empty tables (and still benefit from e.g. outer border)
1339
    //IM_ASSERT(table->IsLayoutLocked && "Table unused: never called TableNextRow(), is that the intent?");
1340
1341
    // If the user never got to call TableNextRow() or TableNextColumn(), we call layout ourselves to ensure all our
1342
    // code paths are consistent (instead of just hoping that TableBegin/TableEnd will work), get borders drawn, etc.
1343
    if (!table->IsLayoutLocked)
1344
        TableUpdateLayout(table);
1345
1346
    const ImGuiTableFlags flags = table->Flags;
1347
    ImGuiWindow* inner_window = table->InnerWindow;
1348
    ImGuiWindow* outer_window = table->OuterWindow;
1349
    ImGuiTableTempData* temp_data = table->TempData;
1350
    IM_ASSERT(inner_window == g.CurrentWindow);
1351
    IM_ASSERT(outer_window == inner_window || outer_window == inner_window->ParentWindow);
1352
1353
    if (table->IsInsideRow)
1354
        TableEndRow(table);
1355
1356
    // Context menu in columns body
1357
    if (flags & ImGuiTableFlags_ContextMenuInBody)
1358
        if (table->HoveredColumnBody != -1 && !IsAnyItemHovered() && IsMouseReleased(ImGuiMouseButton_Right))
1359
            TableOpenContextMenu((int)table->HoveredColumnBody);
1360
1361
    // Finalize table height
1362
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1363
    inner_window->DC.PrevLineSize = temp_data->HostBackupPrevLineSize;
1364
    inner_window->DC.CurrLineSize = temp_data->HostBackupCurrLineSize;
1365
    inner_window->DC.CursorMaxPos = temp_data->HostBackupCursorMaxPos;
1366
    const float inner_content_max_y = table->RowPosY2;
1367
    IM_ASSERT(table->RowPosY2 == inner_window->DC.CursorPos.y);
1368
    if (inner_window != outer_window)
1369
        inner_window->DC.CursorMaxPos.y = inner_content_max_y;
1370
    else if (!(flags & ImGuiTableFlags_NoHostExtendY))
1371
        table->OuterRect.Max.y = table->InnerRect.Max.y = ImMax(table->OuterRect.Max.y, inner_content_max_y); // Patch OuterRect/InnerRect height
1372
    table->WorkRect.Max.y = ImMax(table->WorkRect.Max.y, table->OuterRect.Max.y);
1373
    table_instance->LastOuterHeight = table->OuterRect.GetHeight();
1374
1375
    // Setup inner scrolling range
1376
    // FIXME: This ideally should be done earlier, in BeginTable() SetNextWindowContentSize call, just like writing to inner_window->DC.CursorMaxPos.y,
1377
    // but since the later is likely to be impossible to do we'd rather update both axises together.
1378
    if (table->Flags & ImGuiTableFlags_ScrollX)
1379
    {
1380
        const float outer_padding_for_border = (table->Flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f;
1381
        float max_pos_x = table->InnerWindow->DC.CursorMaxPos.x;
1382
        if (table->RightMostEnabledColumn != -1)
1383
            max_pos_x = ImMax(max_pos_x, table->Columns[table->RightMostEnabledColumn].WorkMaxX + table->CellPaddingX + table->OuterPaddingX - outer_padding_for_border);
1384
        if (table->ResizedColumn != -1)
1385
            max_pos_x = ImMax(max_pos_x, table->ResizeLockMinContentsX2);
1386
        table->InnerWindow->DC.CursorMaxPos.x = max_pos_x + table->TempData->AngledHeadersExtraWidth;
1387
    }
1388
1389
    // Pop clipping rect
1390
    if (!(flags & ImGuiTableFlags_NoClip))
1391
        inner_window->DrawList->PopClipRect();
1392
    inner_window->ClipRect = inner_window->DrawList->_ClipRectStack.back();
1393
1394
    // Draw borders
1395
    if ((flags & ImGuiTableFlags_Borders) != 0)
1396
        TableDrawBorders(table);
1397
1398
#if 0
1399
    // Strip out dummy channel draw calls
1400
    // We have no way to prevent user submitting direct ImDrawList calls into a hidden column (but ImGui:: calls will be clipped out)
1401
    // Pros: remove draw calls which will have no effect. since they'll have zero-size cliprect they may be early out anyway.
1402
    // Cons: making it harder for users watching metrics/debugger to spot the wasted vertices.
1403
    if (table->DummyDrawChannel != (ImGuiTableColumnIdx)-1)
1404
    {
1405
        ImDrawChannel* dummy_channel = &table->DrawSplitter._Channels[table->DummyDrawChannel];
1406
        dummy_channel->_CmdBuffer.resize(0);
1407
        dummy_channel->_IdxBuffer.resize(0);
1408
    }
1409
#endif
1410
1411
    // Flatten channels and merge draw calls
1412
    ImDrawListSplitter* splitter = table->DrawSplitter;
1413
    splitter->SetCurrentChannel(inner_window->DrawList, 0);
1414
    if ((table->Flags & ImGuiTableFlags_NoClip) == 0)
1415
        TableMergeDrawChannels(table);
1416
    splitter->Merge(inner_window->DrawList);
1417
1418
    // Update ColumnsAutoFitWidth to get us ahead for host using our size to auto-resize without waiting for next BeginTable()
1419
    float auto_fit_width_for_fixed = 0.0f;
1420
    float auto_fit_width_for_stretched = 0.0f;
1421
    float auto_fit_width_for_stretched_min = 0.0f;
1422
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
1423
        if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
1424
        {
1425
            ImGuiTableColumn* column = &table->Columns[column_n];
1426
            float column_width_request = ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !(column->Flags & ImGuiTableColumnFlags_NoResize)) ? column->WidthRequest : TableGetColumnWidthAuto(table, column);
1427
            if (column->Flags & ImGuiTableColumnFlags_WidthFixed)
1428
                auto_fit_width_for_fixed += column_width_request;
1429
            else
1430
                auto_fit_width_for_stretched += column_width_request;
1431
            if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) && (column->Flags & ImGuiTableColumnFlags_NoResize) != 0)
1432
                auto_fit_width_for_stretched_min = ImMax(auto_fit_width_for_stretched_min, column_width_request / (column->StretchWeight / table->ColumnsStretchSumWeights));
1433
        }
1434
    const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1);
1435
    table->ColumnsAutoFitWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount + auto_fit_width_for_fixed + ImMax(auto_fit_width_for_stretched, auto_fit_width_for_stretched_min);
1436
1437
    // Update scroll
1438
    if ((table->Flags & ImGuiTableFlags_ScrollX) == 0 && inner_window != outer_window)
1439
    {
1440
        inner_window->Scroll.x = 0.0f;
1441
    }
1442
    else if (table->LastResizedColumn != -1 && table->ResizedColumn == -1 && inner_window->ScrollbarX && table->InstanceInteracted == table->InstanceCurrent)
1443
    {
1444
        // When releasing a column being resized, scroll to keep the resulting column in sight
1445
        const float neighbor_width_to_keep_visible = table->MinColumnWidth + table->CellPaddingX * 2.0f;
1446
        ImGuiTableColumn* column = &table->Columns[table->LastResizedColumn];
1447
        if (column->MaxX < table->InnerClipRect.Min.x)
1448
            SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x - neighbor_width_to_keep_visible, 1.0f);
1449
        else if (column->MaxX > table->InnerClipRect.Max.x)
1450
            SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x + neighbor_width_to_keep_visible, 1.0f);
1451
    }
1452
1453
    // Apply resizing/dragging at the end of the frame
1454
    if (table->ResizedColumn != -1 && table->InstanceCurrent == table->InstanceInteracted)
1455
    {
1456
        ImGuiTableColumn* column = &table->Columns[table->ResizedColumn];
1457
        const float new_x2 = (g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale));
1458
        const float new_width = ImTrunc(new_x2 - column->MinX - table->CellSpacingX1 - table->CellPaddingX * 2.0f);
1459
        table->ResizedColumnNextWidth = new_width;
1460
    }
1461
1462
    table->IsActiveIdInTable = (g.ActiveIdIsAlive != 0 && table->IsActiveIdAliveBeforeTable == false);
1463
1464
    // Pop from id stack
1465
    IM_ASSERT_USER_ERROR(inner_window->IDStack.back() == table_instance->TableInstanceID, "Mismatching PushID/PopID!");
1466
    IM_ASSERT_USER_ERROR(outer_window->DC.ItemWidthStack.Size >= temp_data->HostBackupItemWidthStackSize, "Too many PopItemWidth!");
1467
    if (table->InstanceCurrent > 0)
1468
        PopID();
1469
    PopID();
1470
1471
    // Restore window data that we modified
1472
    const ImVec2 backup_outer_max_pos = outer_window->DC.CursorMaxPos;
1473
    inner_window->WorkRect = temp_data->HostBackupWorkRect;
1474
    inner_window->ParentWorkRect = temp_data->HostBackupParentWorkRect;
1475
    inner_window->SkipItems = table->HostSkipItems;
1476
    outer_window->DC.CursorPos = table->OuterRect.Min;
1477
    outer_window->DC.ItemWidth = temp_data->HostBackupItemWidth;
1478
    outer_window->DC.ItemWidthStack.Size = temp_data->HostBackupItemWidthStackSize;
1479
    outer_window->DC.ColumnsOffset = temp_data->HostBackupColumnsOffset;
1480
1481
    // Layout in outer window
1482
    // (FIXME: To allow auto-fit and allow desirable effect of SameLine() we dissociate 'used' vs 'ideal' size by overriding
1483
    // CursorPosPrevLine and CursorMaxPos manually. That should be a more general layout feature, see same problem e.g. #3414)
1484
    if (inner_window != outer_window)
1485
    {
1486
        short backup_nav_layers_active_mask = inner_window->DC.NavLayersActiveMask;
1487
        inner_window->DC.NavLayersActiveMask |= 1 << ImGuiNavLayer_Main; // So empty table don't appear to navigate differently.
1488
        g.CurrentTable = NULL; // To avoid error recovery recursing
1489
        EndChild();
1490
        g.CurrentTable = table;
1491
        inner_window->DC.NavLayersActiveMask = backup_nav_layers_active_mask;
1492
    }
1493
    else
1494
    {
1495
        ItemSize(table->OuterRect.GetSize());
1496
        ItemAdd(table->OuterRect, 0);
1497
    }
1498
1499
    // Override declared contents width/height to enable auto-resize while not needlessly adding a scrollbar
1500
    if (table->Flags & ImGuiTableFlags_NoHostExtendX)
1501
    {
1502
        // FIXME-TABLE: Could we remove this section?
1503
        // ColumnsAutoFitWidth may be one frame ahead here since for Fixed+NoResize is calculated from latest contents
1504
        IM_ASSERT((table->Flags & ImGuiTableFlags_ScrollX) == 0);
1505
        outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Min.x + table->ColumnsAutoFitWidth);
1506
    }
1507
    else if (temp_data->UserOuterSize.x <= 0.0f)
1508
    {
1509
        // Some references for this: #7651 + tests "table_reported_size", "table_reported_size_outer" equivalent Y block
1510
        // - Checking for ImGuiTableFlags_ScrollX/ScrollY flag makes us a frame ahead when disabling those flags.
1511
        // - FIXME-TABLE: Would make sense to pre-compute expected scrollbar visibility/sizes to generally save a frame of feedback.
1512
        const float inner_content_max_x = table->OuterRect.Min.x + table->ColumnsAutoFitWidth; // Slightly misleading name but used for code symmetry with inner_content_max_y
1513
        const float decoration_size = table->TempData->AngledHeadersExtraWidth + ((table->Flags & ImGuiTableFlags_ScrollY) ? inner_window->ScrollbarSizes.x : 0.0f);
1514
        outer_window->DC.IdealMaxPos.x = ImMax(outer_window->DC.IdealMaxPos.x, inner_content_max_x + decoration_size - temp_data->UserOuterSize.x);
1515
        outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, ImMin(table->OuterRect.Max.x, inner_content_max_x + decoration_size));
1516
    }
1517
    else
1518
    {
1519
        outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Max.x);
1520
    }
1521
    if (temp_data->UserOuterSize.y <= 0.0f)
1522
    {
1523
        const float decoration_size = (table->Flags & ImGuiTableFlags_ScrollX) ? inner_window->ScrollbarSizes.y : 0.0f;
1524
        outer_window->DC.IdealMaxPos.y = ImMax(outer_window->DC.IdealMaxPos.y, inner_content_max_y + decoration_size - temp_data->UserOuterSize.y);
1525
        outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, ImMin(table->OuterRect.Max.y, inner_content_max_y + decoration_size));
1526
    }
1527
    else
1528
    {
1529
        // OuterRect.Max.y may already have been pushed downward from the initial value (unless ImGuiTableFlags_NoHostExtendY is set)
1530
        outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, table->OuterRect.Max.y);
1531
    }
1532
1533
    // Save settings
1534
    if (table->IsSettingsDirty)
1535
        TableSaveSettings(table);
1536
    table->IsInitializing = false;
1537
1538
    // Clear or restore current table, if any
1539
    IM_ASSERT(g.CurrentWindow == outer_window && g.CurrentTable == table);
1540
    IM_ASSERT(g.TablesTempDataStacked > 0);
1541
    temp_data = (--g.TablesTempDataStacked > 0) ? &g.TablesTempData[g.TablesTempDataStacked - 1] : NULL;
1542
    g.CurrentTable = temp_data ? g.Tables.GetByIndex(temp_data->TableIndex) : NULL;
1543
    if (g.CurrentTable)
1544
    {
1545
        g.CurrentTable->TempData = temp_data;
1546
        g.CurrentTable->DrawSplitter = &temp_data->DrawSplitter;
1547
    }
1548
    outer_window->DC.CurrentTableIdx = g.CurrentTable ? g.Tables.GetIndex(g.CurrentTable) : -1;
1549
    NavUpdateCurrentWindowIsScrollPushableX();
1550
}
1551
1552
// See "COLUMNS SIZING POLICIES" comments at the top of this file
1553
// If (init_width_or_weight <= 0.0f) it is ignored
1554
void ImGui::TableSetupColumn(const char* label, ImGuiTableColumnFlags flags, float init_width_or_weight, ImGuiID user_id)
1555
{
1556
    ImGuiContext& g = *GImGui;
1557
    ImGuiTable* table = g.CurrentTable;
1558
    IM_ASSERT(table != NULL && "Need to call TableSetupColumn() after BeginTable()!");
1559
    IM_ASSERT(table->IsLayoutLocked == false && "Need to call call TableSetupColumn() before first row!");
1560
    IM_ASSERT((flags & ImGuiTableColumnFlags_StatusMask_) == 0 && "Illegal to pass StatusMask values to TableSetupColumn()");
1561
    if (table->DeclColumnsCount >= table->ColumnsCount)
1562
    {
1563
        IM_ASSERT_USER_ERROR(table->DeclColumnsCount < table->ColumnsCount, "Called TableSetupColumn() too many times!");
1564
        return;
1565
    }
1566
1567
    ImGuiTableColumn* column = &table->Columns[table->DeclColumnsCount];
1568
    table->DeclColumnsCount++;
1569
1570
    // Assert when passing a width or weight if policy is entirely left to default, to avoid storing width into weight and vice-versa.
1571
    // Give a grace to users of ImGuiTableFlags_ScrollX.
1572
    if (table->IsDefaultSizingPolicy && (flags & ImGuiTableColumnFlags_WidthMask_) == 0 && (flags & ImGuiTableFlags_ScrollX) == 0)
1573
        IM_ASSERT(init_width_or_weight <= 0.0f && "Can only specify width/weight if sizing policy is set explicitly in either Table or Column.");
1574
1575
    // When passing a width automatically enforce WidthFixed policy
1576
    // (whereas TableSetupColumnFlags would default to WidthAuto if table is not Resizable)
1577
    if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0 && init_width_or_weight > 0.0f)
1578
        if ((table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedFit || (table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame)
1579
            flags |= ImGuiTableColumnFlags_WidthFixed;
1580
    if (flags & ImGuiTableColumnFlags_AngledHeader)
1581
    {
1582
        flags |= ImGuiTableColumnFlags_NoHeaderLabel;
1583
        table->AngledHeadersCount++;
1584
    }
1585
1586
    TableSetupColumnFlags(table, column, flags);
1587
    column->UserID = user_id;
1588
    flags = column->Flags;
1589
1590
    // Initialize defaults
1591
    column->InitStretchWeightOrWidth = init_width_or_weight;
1592
    if (table->IsInitializing)
1593
    {
1594
        // Init width or weight
1595
        if (column->WidthRequest < 0.0f && column->StretchWeight < 0.0f)
1596
        {
1597
            if ((flags & ImGuiTableColumnFlags_WidthFixed) && init_width_or_weight > 0.0f)
1598
                column->WidthRequest = init_width_or_weight;
1599
            if (flags & ImGuiTableColumnFlags_WidthStretch)
1600
                column->StretchWeight = (init_width_or_weight > 0.0f) ? init_width_or_weight : -1.0f;
1601
1602
            // Disable auto-fit if an explicit width/weight has been specified
1603
            if (init_width_or_weight > 0.0f)
1604
                column->AutoFitQueue = 0x00;
1605
        }
1606
1607
        // Init default visibility/sort state
1608
        if ((flags & ImGuiTableColumnFlags_DefaultHide) && (table->SettingsLoadedFlags & ImGuiTableFlags_Hideable) == 0)
1609
            column->IsUserEnabled = column->IsUserEnabledNextFrame = false;
1610
        if (flags & ImGuiTableColumnFlags_DefaultSort && (table->SettingsLoadedFlags & ImGuiTableFlags_Sortable) == 0)
1611
        {
1612
            column->SortOrder = 0; // Multiple columns using _DefaultSort will be reassigned unique SortOrder values when building the sort specs.
1613
            column->SortDirection = (column->Flags & ImGuiTableColumnFlags_PreferSortDescending) ? (ImS8)ImGuiSortDirection_Descending : (ImU8)(ImGuiSortDirection_Ascending);
1614
        }
1615
    }
1616
1617
    // Store name (append with zero-terminator in contiguous buffer)
1618
    // FIXME: If we recorded the number of \n in names we could compute header row height
1619
    column->NameOffset = -1;
1620
    if (label != NULL && label[0] != 0)
1621
    {
1622
        column->NameOffset = (ImS16)table->ColumnsNames.size();
1623
        table->ColumnsNames.append(label, label + strlen(label) + 1);
1624
    }
1625
}
1626
1627
// [Public]
1628
void ImGui::TableSetupScrollFreeze(int columns, int rows)
1629
{
1630
    ImGuiContext& g = *GImGui;
1631
    ImGuiTable* table = g.CurrentTable;
1632
    IM_ASSERT(table != NULL && "Need to call TableSetupColumn() after BeginTable()!");
1633
    IM_ASSERT(table->IsLayoutLocked == false && "Need to call TableSetupColumn() before first row!");
1634
    IM_ASSERT(columns >= 0 && columns < IMGUI_TABLE_MAX_COLUMNS);
1635
    IM_ASSERT(rows >= 0 && rows < 128); // Arbitrary limit
1636
1637
    table->FreezeColumnsRequest = (table->Flags & ImGuiTableFlags_ScrollX) ? (ImGuiTableColumnIdx)ImMin(columns, table->ColumnsCount) : 0;
1638
    table->FreezeColumnsCount = (table->InnerWindow->Scroll.x != 0.0f) ? table->FreezeColumnsRequest : 0;
1639
    table->FreezeRowsRequest = (table->Flags & ImGuiTableFlags_ScrollY) ? (ImGuiTableColumnIdx)rows : 0;
1640
    table->FreezeRowsCount = (table->InnerWindow->Scroll.y != 0.0f) ? table->FreezeRowsRequest : 0;
1641
    table->IsUnfrozenRows = (table->FreezeRowsCount == 0); // Make sure this is set before TableUpdateLayout() so ImGuiListClipper can benefit from it.b
1642
1643
    // Ensure frozen columns are ordered in their section. We still allow multiple frozen columns to be reordered.
1644
    // FIXME-TABLE: This work for preserving 2143 into 21|43. How about 4321 turning into 21|43? (preserve relative order in each section)
1645
    for (int column_n = 0; column_n < table->FreezeColumnsRequest; column_n++)
1646
    {
1647
        int order_n = table->DisplayOrderToIndex[column_n];
1648
        if (order_n != column_n && order_n >= table->FreezeColumnsRequest)
1649
        {
1650
            ImSwap(table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder, table->Columns[table->DisplayOrderToIndex[column_n]].DisplayOrder);
1651
            ImSwap(table->DisplayOrderToIndex[order_n], table->DisplayOrderToIndex[column_n]);
1652
        }
1653
    }
1654
}
1655
1656
//-----------------------------------------------------------------------------
1657
// [SECTION] Tables: Simple accessors
1658
//-----------------------------------------------------------------------------
1659
// - TableGetColumnCount()
1660
// - TableGetColumnName()
1661
// - TableGetColumnName() [Internal]
1662
// - TableSetColumnEnabled()
1663
// - TableGetColumnFlags()
1664
// - TableGetCellBgRect() [Internal]
1665
// - TableGetColumnResizeID() [Internal]
1666
// - TableGetHoveredColumn() [Internal]
1667
// - TableGetHoveredRow() [Internal]
1668
// - TableSetBgColor()
1669
//-----------------------------------------------------------------------------
1670
1671
int ImGui::TableGetColumnCount()
1672
{
1673
    ImGuiContext& g = *GImGui;
1674
    ImGuiTable* table = g.CurrentTable;
1675
    return table ? table->ColumnsCount : 0;
1676
}
1677
1678
const char* ImGui::TableGetColumnName(int column_n)
1679
{
1680
    ImGuiContext& g = *GImGui;
1681
    ImGuiTable* table = g.CurrentTable;
1682
    if (!table)
1683
        return NULL;
1684
    if (column_n < 0)
1685
        column_n = table->CurrentColumn;
1686
    return TableGetColumnName(table, column_n);
1687
}
1688
1689
const char* ImGui::TableGetColumnName(const ImGuiTable* table, int column_n)
1690
{
1691
    if (table->IsLayoutLocked == false && column_n >= table->DeclColumnsCount)
1692
        return ""; // NameOffset is invalid at this point
1693
    const ImGuiTableColumn* column = &table->Columns[column_n];
1694
    if (column->NameOffset == -1)
1695
        return "";
1696
    return &table->ColumnsNames.Buf[column->NameOffset];
1697
}
1698
1699
// Change user accessible enabled/disabled state of a column (often perceived as "showing/hiding" from users point of view)
1700
// Note that end-user can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody)
1701
// - Require table to have the ImGuiTableFlags_Hideable flag because we are manipulating user accessible state.
1702
// - Request will be applied during next layout, which happens on the first call to TableNextRow() after BeginTable().
1703
// - For the getter you can test (TableGetColumnFlags() & ImGuiTableColumnFlags_IsEnabled) != 0.
1704
// - Alternative: the ImGuiTableColumnFlags_Disabled is an overriding/master disable flag which will also hide the column from context menu.
1705
void ImGui::TableSetColumnEnabled(int column_n, bool enabled)
1706
{
1707
    ImGuiContext& g = *GImGui;
1708
    ImGuiTable* table = g.CurrentTable;
1709
    IM_ASSERT(table != NULL);
1710
    if (!table)
1711
        return;
1712
    IM_ASSERT(table->Flags & ImGuiTableFlags_Hideable); // See comments above
1713
    if (column_n < 0)
1714
        column_n = table->CurrentColumn;
1715
    IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
1716
    ImGuiTableColumn* column = &table->Columns[column_n];
1717
    column->IsUserEnabledNextFrame = enabled;
1718
}
1719
1720
// We allow querying for an extra column in order to poll the IsHovered state of the right-most section
1721
ImGuiTableColumnFlags ImGui::TableGetColumnFlags(int column_n)
1722
{
1723
    ImGuiContext& g = *GImGui;
1724
    ImGuiTable* table = g.CurrentTable;
1725
    if (!table)
1726
        return ImGuiTableColumnFlags_None;
1727
    if (column_n < 0)
1728
        column_n = table->CurrentColumn;
1729
    if (column_n == table->ColumnsCount)
1730
        return (table->HoveredColumnBody == column_n) ? ImGuiTableColumnFlags_IsHovered : ImGuiTableColumnFlags_None;
1731
    return table->Columns[column_n].Flags;
1732
}
1733
1734
// Return the cell rectangle based on currently known height.
1735
// - Important: we generally don't know our row height until the end of the row, so Max.y will be incorrect in many situations.
1736
//   The only case where this is correct is if we provided a min_row_height to TableNextRow() and don't go below it, or in TableEndRow() when we locked that height.
1737
// - Important: if ImGuiTableFlags_PadOuterX is set but ImGuiTableFlags_PadInnerX is not set, the outer-most left and right
1738
//   columns report a small offset so their CellBgRect can extend up to the outer border.
1739
//   FIXME: But the rendering code in TableEndRow() nullifies that with clamping required for scrolling.
1740
ImRect ImGui::TableGetCellBgRect(const ImGuiTable* table, int column_n)
1741
{
1742
    const ImGuiTableColumn* column = &table->Columns[column_n];
1743
    float x1 = column->MinX;
1744
    float x2 = column->MaxX;
1745
    //if (column->PrevEnabledColumn == -1)
1746
    //    x1 -= table->OuterPaddingX;
1747
    //if (column->NextEnabledColumn == -1)
1748
    //    x2 += table->OuterPaddingX;
1749
    x1 = ImMax(x1, table->WorkRect.Min.x);
1750
    x2 = ImMin(x2, table->WorkRect.Max.x);
1751
    return ImRect(x1, table->RowPosY1, x2, table->RowPosY2);
1752
}
1753
1754
// Return the resizing ID for the right-side of the given column.
1755
ImGuiID ImGui::TableGetColumnResizeID(ImGuiTable* table, int column_n, int instance_no)
1756
{
1757
    IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
1758
    ImGuiID instance_id = TableGetInstanceID(table, instance_no);
1759
    return instance_id + 1 + column_n; // FIXME: #6140: still not ideal
1760
}
1761
1762
// Return -1 when table is not hovered. return columns_count if hovering the unused space at the right of the right-most visible column.
1763
int ImGui::TableGetHoveredColumn()
1764
{
1765
    ImGuiContext& g = *GImGui;
1766
    ImGuiTable* table = g.CurrentTable;
1767
    if (!table)
1768
        return -1;
1769
    return (int)table->HoveredColumnBody;
1770
}
1771
1772
// Return -1 when table is not hovered. Return maxrow+1 if in table but below last submitted row.
1773
// *IMPORTANT* Unlike TableGetHoveredColumn(), this has a one frame latency in updating the value.
1774
// This difference with is the reason why this is not public yet.
1775
int ImGui::TableGetHoveredRow()
1776
{
1777
    ImGuiContext& g = *GImGui;
1778
    ImGuiTable* table = g.CurrentTable;
1779
    if (!table)
1780
        return -1;
1781
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1782
    return (int)table_instance->HoveredRowLast;
1783
}
1784
1785
void ImGui::TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n)
1786
{
1787
    ImGuiContext& g = *GImGui;
1788
    ImGuiTable* table = g.CurrentTable;
1789
    IM_ASSERT(target != ImGuiTableBgTarget_None);
1790
1791
    if (color == IM_COL32_DISABLE)
1792
        color = 0;
1793
1794
    // We cannot draw neither the cell or row background immediately as we don't know the row height at this point in time.
1795
    switch (target)
1796
    {
1797
    case ImGuiTableBgTarget_CellBg:
1798
    {
1799
        if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard
1800
            return;
1801
        if (column_n == -1)
1802
            column_n = table->CurrentColumn;
1803
        if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n))
1804
            return;
1805
        if (table->RowCellDataCurrent < 0 || table->RowCellData[table->RowCellDataCurrent].Column != column_n)
1806
            table->RowCellDataCurrent++;
1807
        ImGuiTableCellData* cell_data = &table->RowCellData[table->RowCellDataCurrent];
1808
        cell_data->BgColor = color;
1809
        cell_data->Column = (ImGuiTableColumnIdx)column_n;
1810
        break;
1811
    }
1812
    case ImGuiTableBgTarget_RowBg0:
1813
    case ImGuiTableBgTarget_RowBg1:
1814
    {
1815
        if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard
1816
            return;
1817
        IM_ASSERT(column_n == -1);
1818
        int bg_idx = (target == ImGuiTableBgTarget_RowBg1) ? 1 : 0;
1819
        table->RowBgColor[bg_idx] = color;
1820
        break;
1821
    }
1822
    default:
1823
        IM_ASSERT(0);
1824
    }
1825
}
1826
1827
//-------------------------------------------------------------------------
1828
// [SECTION] Tables: Row changes
1829
//-------------------------------------------------------------------------
1830
// - TableGetRowIndex()
1831
// - TableNextRow()
1832
// - TableBeginRow() [Internal]
1833
// - TableEndRow() [Internal]
1834
//-------------------------------------------------------------------------
1835
1836
// [Public] Note: for row coloring we use ->RowBgColorCounter which is the same value without counting header rows
1837
int ImGui::TableGetRowIndex()
1838
{
1839
    ImGuiContext& g = *GImGui;
1840
    ImGuiTable* table = g.CurrentTable;
1841
    if (!table)
1842
        return 0;
1843
    return table->CurrentRow;
1844
}
1845
1846
// [Public] Starts into the first cell of a new row
1847
void ImGui::TableNextRow(ImGuiTableRowFlags row_flags, float row_min_height)
1848
{
1849
    ImGuiContext& g = *GImGui;
1850
    ImGuiTable* table = g.CurrentTable;
1851
1852
    if (!table->IsLayoutLocked)
1853
        TableUpdateLayout(table);
1854
    if (table->IsInsideRow)
1855
        TableEndRow(table);
1856
1857
    table->LastRowFlags = table->RowFlags;
1858
    table->RowFlags = row_flags;
1859
    table->RowCellPaddingY = g.Style.CellPadding.y;
1860
    table->RowMinHeight = row_min_height;
1861
    TableBeginRow(table);
1862
1863
    // We honor min_row_height requested by user, but cannot guarantee per-row maximum height,
1864
    // because that would essentially require a unique clipping rectangle per-cell.
1865
    table->RowPosY2 += table->RowCellPaddingY * 2.0f;
1866
    table->RowPosY2 = ImMax(table->RowPosY2, table->RowPosY1 + row_min_height);
1867
1868
    // Disable output until user calls TableNextColumn()
1869
    table->InnerWindow->SkipItems = true;
1870
}
1871
1872
// [Internal] Only called by TableNextRow()
1873
void ImGui::TableBeginRow(ImGuiTable* table)
1874
{
1875
    ImGuiWindow* window = table->InnerWindow;
1876
    IM_ASSERT(!table->IsInsideRow);
1877
1878
    // New row
1879
    table->CurrentRow++;
1880
    table->CurrentColumn = -1;
1881
    table->RowBgColor[0] = table->RowBgColor[1] = IM_COL32_DISABLE;
1882
    table->RowCellDataCurrent = -1;
1883
    table->IsInsideRow = true;
1884
1885
    // Begin frozen rows
1886
    float next_y1 = table->RowPosY2;
1887
    if (table->CurrentRow == 0 && table->FreezeRowsCount > 0)
1888
        next_y1 = window->DC.CursorPos.y = table->OuterRect.Min.y;
1889
1890
    table->RowPosY1 = table->RowPosY2 = next_y1;
1891
    table->RowTextBaseline = 0.0f;
1892
    table->RowIndentOffsetX = window->DC.Indent.x - table->HostIndentX; // Lock indent
1893
1894
    window->DC.PrevLineTextBaseOffset = 0.0f;
1895
    window->DC.CursorPosPrevLine = ImVec2(window->DC.CursorPos.x, window->DC.CursorPos.y + table->RowCellPaddingY); // This allows users to call SameLine() to share LineSize between columns.
1896
    window->DC.PrevLineSize = window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); // This allows users to call SameLine() to share LineSize between columns, and to call it from first column too.
1897
    window->DC.IsSameLine = window->DC.IsSetPos = false;
1898
    window->DC.CursorMaxPos.y = next_y1;
1899
1900
    // Making the header BG color non-transparent will allow us to overlay it multiple times when handling smooth dragging.
1901
    if (table->RowFlags & ImGuiTableRowFlags_Headers)
1902
    {
1903
        TableSetBgColor(ImGuiTableBgTarget_RowBg0, GetColorU32(ImGuiCol_TableHeaderBg));
1904
        if (table->CurrentRow == 0)
1905
            table->IsUsingHeaders = true;
1906
    }
1907
}
1908
1909
// [Internal] Called by TableNextRow()
1910
void ImGui::TableEndRow(ImGuiTable* table)
1911
{
1912
    ImGuiContext& g = *GImGui;
1913
    ImGuiWindow* window = g.CurrentWindow;
1914
    IM_ASSERT(window == table->InnerWindow);
1915
    IM_ASSERT(table->IsInsideRow);
1916
1917
    if (table->CurrentColumn != -1)
1918
        TableEndCell(table);
1919
1920
    // Logging
1921
    if (g.LogEnabled)
1922
        LogRenderedText(NULL, "|");
1923
1924
    // Position cursor at the bottom of our row so it can be used for e.g. clipping calculation. However it is
1925
    // likely that the next call to TableBeginCell() will reposition the cursor to take account of vertical padding.
1926
    window->DC.CursorPos.y = table->RowPosY2;
1927
1928
    // Row background fill
1929
    const float bg_y1 = table->RowPosY1;
1930
    const float bg_y2 = table->RowPosY2;
1931
    const bool unfreeze_rows_actual = (table->CurrentRow + 1 == table->FreezeRowsCount);
1932
    const bool unfreeze_rows_request = (table->CurrentRow + 1 == table->FreezeRowsRequest);
1933
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
1934
    if ((table->RowFlags & ImGuiTableRowFlags_Headers) && (table->CurrentRow == 0 || (table->LastRowFlags & ImGuiTableRowFlags_Headers)))
1935
        table_instance->LastTopHeadersRowHeight += bg_y2 - bg_y1;
1936
1937
    const bool is_visible = (bg_y2 >= table->InnerClipRect.Min.y && bg_y1 <= table->InnerClipRect.Max.y);
1938
    if (is_visible)
1939
    {
1940
        // Update data for TableGetHoveredRow()
1941
        if (table->HoveredColumnBody != -1 && g.IO.MousePos.y >= bg_y1 && g.IO.MousePos.y < bg_y2 && table_instance->HoveredRowNext < 0)
1942
            table_instance->HoveredRowNext = table->CurrentRow;
1943
1944
        // Decide of background color for the row
1945
        ImU32 bg_col0 = 0;
1946
        ImU32 bg_col1 = 0;
1947
        if (table->RowBgColor[0] != IM_COL32_DISABLE)
1948
            bg_col0 = table->RowBgColor[0];
1949
        else if (table->Flags & ImGuiTableFlags_RowBg)
1950
            bg_col0 = GetColorU32((table->RowBgColorCounter & 1) ? ImGuiCol_TableRowBgAlt : ImGuiCol_TableRowBg);
1951
        if (table->RowBgColor[1] != IM_COL32_DISABLE)
1952
            bg_col1 = table->RowBgColor[1];
1953
1954
        // Decide of top border color
1955
        ImU32 top_border_col = 0;
1956
        const float border_size = TABLE_BORDER_SIZE;
1957
        if (table->CurrentRow > 0 && (table->Flags & ImGuiTableFlags_BordersInnerH))
1958
            top_border_col = (table->LastRowFlags & ImGuiTableRowFlags_Headers) ? table->BorderColorStrong : table->BorderColorLight;
1959
1960
        const bool draw_cell_bg_color = table->RowCellDataCurrent >= 0;
1961
        const bool draw_strong_bottom_border = unfreeze_rows_actual;
1962
        if ((bg_col0 | bg_col1 | top_border_col) != 0 || draw_strong_bottom_border || draw_cell_bg_color)
1963
        {
1964
            // In theory we could call SetWindowClipRectBeforeSetChannel() but since we know TableEndRow() is
1965
            // always followed by a change of clipping rectangle we perform the smallest overwrite possible here.
1966
            if ((table->Flags & ImGuiTableFlags_NoClip) == 0)
1967
                window->DrawList->_CmdHeader.ClipRect = table->Bg0ClipRectForDrawCmd.ToVec4();
1968
            table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_BG0);
1969
        }
1970
1971
        // Draw row background
1972
        // We soft/cpu clip this so all backgrounds and borders can share the same clipping rectangle
1973
        if (bg_col0 || bg_col1)
1974
        {
1975
            ImRect row_rect(table->WorkRect.Min.x, bg_y1, table->WorkRect.Max.x, bg_y2);
1976
            row_rect.ClipWith(table->BgClipRect);
1977
            if (bg_col0 != 0 && row_rect.Min.y < row_rect.Max.y)
1978
                window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col0);
1979
            if (bg_col1 != 0 && row_rect.Min.y < row_rect.Max.y)
1980
                window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col1);
1981
        }
1982
1983
        // Draw cell background color
1984
        if (draw_cell_bg_color)
1985
        {
1986
            ImGuiTableCellData* cell_data_end = &table->RowCellData[table->RowCellDataCurrent];
1987
            for (ImGuiTableCellData* cell_data = &table->RowCellData[0]; cell_data <= cell_data_end; cell_data++)
1988
            {
1989
                // As we render the BG here we need to clip things (for layout we would not)
1990
                // FIXME: This cancels the OuterPadding addition done by TableGetCellBgRect(), need to keep it while rendering correctly while scrolling.
1991
                const ImGuiTableColumn* column = &table->Columns[cell_data->Column];
1992
                ImRect cell_bg_rect = TableGetCellBgRect(table, cell_data->Column);
1993
                cell_bg_rect.ClipWith(table->BgClipRect);
1994
                cell_bg_rect.Min.x = ImMax(cell_bg_rect.Min.x, column->ClipRect.Min.x);     // So that first column after frozen one gets clipped when scrolling
1995
                cell_bg_rect.Max.x = ImMin(cell_bg_rect.Max.x, column->MaxX);
1996
                if (cell_bg_rect.Min.y < cell_bg_rect.Max.y)
1997
                    window->DrawList->AddRectFilled(cell_bg_rect.Min, cell_bg_rect.Max, cell_data->BgColor);
1998
            }
1999
        }
2000
2001
        // Draw top border
2002
        if (top_border_col && bg_y1 >= table->BgClipRect.Min.y && bg_y1 < table->BgClipRect.Max.y)
2003
            window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y1), ImVec2(table->BorderX2, bg_y1), top_border_col, border_size);
2004
2005
        // Draw bottom border at the row unfreezing mark (always strong)
2006
        if (draw_strong_bottom_border && bg_y2 >= table->BgClipRect.Min.y && bg_y2 < table->BgClipRect.Max.y)
2007
            window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y2), ImVec2(table->BorderX2, bg_y2), table->BorderColorStrong, border_size);
2008
    }
2009
2010
    // End frozen rows (when we are past the last frozen row line, teleport cursor and alter clipping rectangle)
2011
    // We need to do that in TableEndRow() instead of TableBeginRow() so the list clipper can mark end of row and
2012
    // get the new cursor position.
2013
    if (unfreeze_rows_request)
2014
    {
2015
        for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2016
            table->Columns[column_n].NavLayerCurrent = ImGuiNavLayer_Main;
2017
        const float y0 = ImMax(table->RowPosY2 + 1, table->InnerClipRect.Min.y);
2018
        table_instance->LastFrozenHeight = y0 - table->OuterRect.Min.y;
2019
2020
        if (unfreeze_rows_actual)
2021
        {
2022
            IM_ASSERT(table->IsUnfrozenRows == false);
2023
            table->IsUnfrozenRows = true;
2024
2025
            // BgClipRect starts as table->InnerClipRect, reduce it now and make BgClipRectForDrawCmd == BgClipRect
2026
            table->BgClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y = ImMin(y0, table->InnerClipRect.Max.y);
2027
            table->BgClipRect.Max.y = table->Bg2ClipRectForDrawCmd.Max.y = table->InnerClipRect.Max.y;
2028
            table->Bg2DrawChannelCurrent = table->Bg2DrawChannelUnfrozen;
2029
            IM_ASSERT(table->Bg2ClipRectForDrawCmd.Min.y <= table->Bg2ClipRectForDrawCmd.Max.y);
2030
2031
            float row_height = table->RowPosY2 - table->RowPosY1;
2032
            table->RowPosY2 = window->DC.CursorPos.y = table->WorkRect.Min.y + table->RowPosY2 - table->OuterRect.Min.y;
2033
            table->RowPosY1 = table->RowPosY2 - row_height;
2034
            for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2035
            {
2036
                ImGuiTableColumn* column = &table->Columns[column_n];
2037
                column->DrawChannelCurrent = column->DrawChannelUnfrozen;
2038
                column->ClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y;
2039
            }
2040
2041
            // Update cliprect ahead of TableBeginCell() so clipper can access to new ClipRect->Min.y
2042
            SetWindowClipRectBeforeSetChannel(window, table->Columns[0].ClipRect);
2043
            table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Columns[0].DrawChannelCurrent);
2044
        }
2045
    }
2046
2047
    if (!(table->RowFlags & ImGuiTableRowFlags_Headers))
2048
        table->RowBgColorCounter++;
2049
    table->IsInsideRow = false;
2050
}
2051
2052
//-------------------------------------------------------------------------
2053
// [SECTION] Tables: Columns changes
2054
//-------------------------------------------------------------------------
2055
// - TableGetColumnIndex()
2056
// - TableSetColumnIndex()
2057
// - TableNextColumn()
2058
// - TableBeginCell() [Internal]
2059
// - TableEndCell() [Internal]
2060
//-------------------------------------------------------------------------
2061
2062
int ImGui::TableGetColumnIndex()
2063
{
2064
    ImGuiContext& g = *GImGui;
2065
    ImGuiTable* table = g.CurrentTable;
2066
    if (!table)
2067
        return 0;
2068
    return table->CurrentColumn;
2069
}
2070
2071
// [Public] Append into a specific column
2072
bool ImGui::TableSetColumnIndex(int column_n)
2073
{
2074
    ImGuiContext& g = *GImGui;
2075
    ImGuiTable* table = g.CurrentTable;
2076
    if (!table)
2077
        return false;
2078
2079
    if (table->CurrentColumn != column_n)
2080
    {
2081
        if (table->CurrentColumn != -1)
2082
            TableEndCell(table);
2083
        IM_ASSERT(column_n >= 0 && table->ColumnsCount);
2084
        TableBeginCell(table, column_n);
2085
    }
2086
2087
    // Return whether the column is visible. User may choose to skip submitting items based on this return value,
2088
    // however they shouldn't skip submitting for columns that may have the tallest contribution to row height.
2089
    return table->Columns[column_n].IsRequestOutput;
2090
}
2091
2092
// [Public] Append into the next column, wrap and create a new row when already on last column
2093
bool ImGui::TableNextColumn()
2094
{
2095
    ImGuiContext& g = *GImGui;
2096
    ImGuiTable* table = g.CurrentTable;
2097
    if (!table)
2098
        return false;
2099
2100
    if (table->IsInsideRow && table->CurrentColumn + 1 < table->ColumnsCount)
2101
    {
2102
        if (table->CurrentColumn != -1)
2103
            TableEndCell(table);
2104
        TableBeginCell(table, table->CurrentColumn + 1);
2105
    }
2106
    else
2107
    {
2108
        TableNextRow();
2109
        TableBeginCell(table, 0);
2110
    }
2111
2112
    // Return whether the column is visible. User may choose to skip submitting items based on this return value,
2113
    // however they shouldn't skip submitting for columns that may have the tallest contribution to row height.
2114
    return table->Columns[table->CurrentColumn].IsRequestOutput;
2115
}
2116
2117
2118
// [Internal] Called by TableSetColumnIndex()/TableNextColumn()
2119
// This is called very frequently, so we need to be mindful of unnecessary overhead.
2120
// FIXME-TABLE FIXME-OPT: Could probably shortcut some things for non-active or clipped columns.
2121
void ImGui::TableBeginCell(ImGuiTable* table, int column_n)
2122
{
2123
    ImGuiContext& g = *GImGui;
2124
    ImGuiTableColumn* column = &table->Columns[column_n];
2125
    ImGuiWindow* window = table->InnerWindow;
2126
    table->CurrentColumn = column_n;
2127
2128
    // Start position is roughly ~~ CellRect.Min + CellPadding + Indent
2129
    float start_x = column->WorkMinX;
2130
    if (column->Flags & ImGuiTableColumnFlags_IndentEnable)
2131
        start_x += table->RowIndentOffsetX; // ~~ += window.DC.Indent.x - table->HostIndentX, except we locked it for the row.
2132
2133
    window->DC.CursorPos.x = start_x;
2134
    window->DC.CursorPos.y = table->RowPosY1 + table->RowCellPaddingY;
2135
    window->DC.CursorMaxPos.x = window->DC.CursorPos.x;
2136
    window->DC.ColumnsOffset.x = start_x - window->Pos.x - window->DC.Indent.x; // FIXME-WORKRECT
2137
    window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x; // PrevLine.y is preserved. This allows users to call SameLine() to share LineSize between columns.
2138
    window->DC.CurrLineTextBaseOffset = table->RowTextBaseline;
2139
    window->DC.NavLayerCurrent = (ImGuiNavLayer)column->NavLayerCurrent;
2140
2141
    // Note how WorkRect.Max.y is only set once during layout
2142
    window->WorkRect.Min.y = window->DC.CursorPos.y;
2143
    window->WorkRect.Min.x = column->WorkMinX;
2144
    window->WorkRect.Max.x = column->WorkMaxX;
2145
    window->DC.ItemWidth = column->ItemWidth;
2146
2147
    window->SkipItems = column->IsSkipItems;
2148
    if (column->IsSkipItems)
2149
    {
2150
        g.LastItemData.ID = 0;
2151
        g.LastItemData.StatusFlags = 0;
2152
    }
2153
2154
    if (table->Flags & ImGuiTableFlags_NoClip)
2155
    {
2156
        // FIXME: if we end up drawing all borders/bg in EndTable, could remove this and just assert that channel hasn't changed.
2157
        table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP);
2158
        //IM_ASSERT(table->DrawSplitter._Current == TABLE_DRAW_CHANNEL_NOCLIP);
2159
    }
2160
    else
2161
    {
2162
        // FIXME-TABLE: Could avoid this if draw channel is dummy channel?
2163
        SetWindowClipRectBeforeSetChannel(window, column->ClipRect);
2164
        table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent);
2165
    }
2166
2167
    // Logging
2168
    if (g.LogEnabled && !column->IsSkipItems)
2169
    {
2170
        LogRenderedText(&window->DC.CursorPos, "|");
2171
        g.LogLinePosY = FLT_MAX;
2172
    }
2173
}
2174
2175
// [Internal] Called by TableNextRow()/TableSetColumnIndex()/TableNextColumn()
2176
void ImGui::TableEndCell(ImGuiTable* table)
2177
{
2178
    ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
2179
    ImGuiWindow* window = table->InnerWindow;
2180
2181
    if (window->DC.IsSetPos)
2182
        ErrorCheckUsingSetCursorPosToExtendParentBoundaries();
2183
2184
    // Report maximum position so we can infer content size per column.
2185
    float* p_max_pos_x;
2186
    if (table->RowFlags & ImGuiTableRowFlags_Headers)
2187
        p_max_pos_x = &column->ContentMaxXHeadersUsed;  // Useful in case user submit contents in header row that is not a TableHeader() call
2188
    else
2189
        p_max_pos_x = table->IsUnfrozenRows ? &column->ContentMaxXUnfrozen : &column->ContentMaxXFrozen;
2190
    *p_max_pos_x = ImMax(*p_max_pos_x, window->DC.CursorMaxPos.x);
2191
    if (column->IsEnabled)
2192
        table->RowPosY2 = ImMax(table->RowPosY2, window->DC.CursorMaxPos.y + table->RowCellPaddingY);
2193
    column->ItemWidth = window->DC.ItemWidth;
2194
2195
    // Propagate text baseline for the entire row
2196
    // FIXME-TABLE: Here we propagate text baseline from the last line of the cell.. instead of the first one.
2197
    table->RowTextBaseline = ImMax(table->RowTextBaseline, window->DC.PrevLineTextBaseOffset);
2198
}
2199
2200
//-------------------------------------------------------------------------
2201
// [SECTION] Tables: Columns width management
2202
//-------------------------------------------------------------------------
2203
// - TableGetMaxColumnWidth() [Internal]
2204
// - TableGetColumnWidthAuto() [Internal]
2205
// - TableSetColumnWidth()
2206
// - TableSetColumnWidthAutoSingle() [Internal]
2207
// - TableSetColumnWidthAutoAll() [Internal]
2208
// - TableUpdateColumnsWeightFromWidth() [Internal]
2209
//-------------------------------------------------------------------------
2210
// Note that actual columns widths are computed in TableUpdateLayout().
2211
//-------------------------------------------------------------------------
2212
2213
// Maximum column content width given current layout. Use column->MinX so this value differs on a per-column basis.
2214
float ImGui::TableCalcMaxColumnWidth(const ImGuiTable* table, int column_n)
2215
{
2216
    const ImGuiTableColumn* column = &table->Columns[column_n];
2217
    float max_width = FLT_MAX;
2218
    const float min_column_distance = table->MinColumnWidth + table->CellPaddingX * 2.0f + table->CellSpacingX1 + table->CellSpacingX2;
2219
    if (table->Flags & ImGuiTableFlags_ScrollX)
2220
    {
2221
        // Frozen columns can't reach beyond visible width else scrolling will naturally break.
2222
        // (we use DisplayOrder as within a set of multiple frozen column reordering is possible)
2223
        if (column->DisplayOrder < table->FreezeColumnsRequest)
2224
        {
2225
            max_width = (table->InnerClipRect.Max.x - (table->FreezeColumnsRequest - column->DisplayOrder) * min_column_distance) - column->MinX;
2226
            max_width = max_width - table->OuterPaddingX - table->CellPaddingX - table->CellSpacingX2;
2227
        }
2228
    }
2229
    else if ((table->Flags & ImGuiTableFlags_NoKeepColumnsVisible) == 0)
2230
    {
2231
        // If horizontal scrolling if disabled, we apply a final lossless shrinking of columns in order to make
2232
        // sure they are all visible. Because of this we also know that all of the columns will always fit in
2233
        // table->WorkRect and therefore in table->InnerRect (because ScrollX is off)
2234
        // FIXME-TABLE: This is solved incorrectly but also quite a difficult problem to fix as we also want ClipRect width to match.
2235
        // See "table_width_distrib" and "table_width_keep_visible" tests
2236
        max_width = table->WorkRect.Max.x - (table->ColumnsEnabledCount - column->IndexWithinEnabledSet - 1) * min_column_distance - column->MinX;
2237
        //max_width -= table->CellSpacingX1;
2238
        max_width -= table->CellSpacingX2;
2239
        max_width -= table->CellPaddingX * 2.0f;
2240
        max_width -= table->OuterPaddingX;
2241
    }
2242
    return max_width;
2243
}
2244
2245
// Note this is meant to be stored in column->WidthAuto, please generally use the WidthAuto field
2246
float ImGui::TableGetColumnWidthAuto(ImGuiTable* table, ImGuiTableColumn* column)
2247
{
2248
    const float content_width_body = ImMax(column->ContentMaxXFrozen, column->ContentMaxXUnfrozen) - column->WorkMinX;
2249
    const float content_width_headers = column->ContentMaxXHeadersIdeal - column->WorkMinX;
2250
    float width_auto = content_width_body;
2251
    if (!(column->Flags & ImGuiTableColumnFlags_NoHeaderWidth))
2252
        width_auto = ImMax(width_auto, content_width_headers);
2253
2254
    // Non-resizable fixed columns preserve their requested width
2255
    if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f)
2256
        if (!(table->Flags & ImGuiTableFlags_Resizable) || (column->Flags & ImGuiTableColumnFlags_NoResize))
2257
            width_auto = column->InitStretchWeightOrWidth;
2258
2259
    return ImMax(width_auto, table->MinColumnWidth);
2260
}
2261
2262
// 'width' = inner column width, without padding
2263
void ImGui::TableSetColumnWidth(int column_n, float width)
2264
{
2265
    ImGuiContext& g = *GImGui;
2266
    ImGuiTable* table = g.CurrentTable;
2267
    IM_ASSERT(table != NULL && table->IsLayoutLocked == false);
2268
    IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
2269
    ImGuiTableColumn* column_0 = &table->Columns[column_n];
2270
    float column_0_width = width;
2271
2272
    // Apply constraints early
2273
    // Compare both requested and actual given width to avoid overwriting requested width when column is stuck (minimum size, bounded)
2274
    IM_ASSERT(table->MinColumnWidth > 0.0f);
2275
    const float min_width = table->MinColumnWidth;
2276
    const float max_width = ImMax(min_width, column_0->WidthMax); // Don't use TableCalcMaxColumnWidth() here as it would rely on MinX from last instance (#7933)
2277
    column_0_width = ImClamp(column_0_width, min_width, max_width);
2278
    if (column_0->WidthGiven == column_0_width || column_0->WidthRequest == column_0_width)
2279
        return;
2280
2281
    //IMGUI_DEBUG_PRINT("TableSetColumnWidth(%d, %.1f->%.1f)\n", column_0_idx, column_0->WidthGiven, column_0_width);
2282
    ImGuiTableColumn* column_1 = (column_0->NextEnabledColumn != -1) ? &table->Columns[column_0->NextEnabledColumn] : NULL;
2283
2284
    // In this surprisingly not simple because of how we support mixing Fixed and multiple Stretch columns.
2285
    // - All fixed: easy.
2286
    // - All stretch: easy.
2287
    // - One or more fixed + one stretch: easy.
2288
    // - One or more fixed + more than one stretch: tricky.
2289
    // Qt when manual resize is enabled only supports a single _trailing_ stretch column, we support more cases here.
2290
2291
    // When forwarding resize from Wn| to Fn+1| we need to be considerate of the _NoResize flag on Fn+1.
2292
    // FIXME-TABLE: Find a way to rewrite all of this so interactions feel more consistent for the user.
2293
    // Scenarios:
2294
    // - F1 F2 F3  resize from F1| or F2|   --> ok: alter ->WidthRequested of Fixed column. Subsequent columns will be offset.
2295
    // - F1 F2 F3  resize from F3|          --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered.
2296
    // - F1 F2 W3  resize from F1| or F2|   --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered, but it doesn't make much sense as the Stretch column will always be minimal size.
2297
    // - F1 F2 W3  resize from W3|          --> ok: no-op (disabled by Resize Rule 1)
2298
    // - W1 W2 W3  resize from W1| or W2|   --> ok
2299
    // - W1 W2 W3  resize from W3|          --> ok: no-op (disabled by Resize Rule 1)
2300
    // - W1 F2 F3  resize from F3|          --> ok: no-op (disabled by Resize Rule 1)
2301
    // - W1 F2     resize from F2|          --> ok: no-op (disabled by Resize Rule 1)
2302
    // - W1 W2 F3  resize from W1| or W2|   --> ok
2303
    // - W1 F2 W3  resize from W1| or F2|   --> ok
2304
    // - F1 W2 F3  resize from W2|          --> ok
2305
    // - F1 W3 F2  resize from W3|          --> ok
2306
    // - W1 F2 F3  resize from W1|          --> ok: equivalent to resizing |F2. F3 will not move.
2307
    // - W1 F2 F3  resize from F2|          --> ok
2308
    // All resizes from a Wx columns are locking other columns.
2309
2310
    // Possible improvements:
2311
    // - W1 W2 W3  resize W1|               --> to not be stuck, both W2 and W3 would stretch down. Seems possible to fix. Would be most beneficial to simplify resize of all-weighted columns.
2312
    // - W3 F1 F2  resize W3|               --> to not be stuck past F1|, both F1 and F2 would need to stretch down, which would be lossy or ambiguous. Seems hard to fix.
2313
2314
    // [Resize Rule 1] Can't resize from right of right-most visible column if there is any Stretch column. Implemented in TableUpdateLayout().
2315
2316
    // If we have all Fixed columns OR resizing a Fixed column that doesn't come after a Stretch one, we can do an offsetting resize.
2317
    // This is the preferred resize path
2318
    if (column_0->Flags & ImGuiTableColumnFlags_WidthFixed)
2319
        if (!column_1 || table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder >= column_0->DisplayOrder)
2320
        {
2321
            column_0->WidthRequest = column_0_width;
2322
            table->IsSettingsDirty = true;
2323
            return;
2324
        }
2325
2326
    // We can also use previous column if there's no next one (this is used when doing an auto-fit on the right-most stretch column)
2327
    if (column_1 == NULL)
2328
        column_1 = (column_0->PrevEnabledColumn != -1) ? &table->Columns[column_0->PrevEnabledColumn] : NULL;
2329
    if (column_1 == NULL)
2330
        return;
2331
2332
    // Resizing from right-side of a Stretch column before a Fixed column forward sizing to left-side of fixed column.
2333
    // (old_a + old_b == new_a + new_b) --> (new_a == old_a + old_b - new_b)
2334
    float column_1_width = ImMax(column_1->WidthRequest - (column_0_width - column_0->WidthRequest), min_width);
2335
    column_0_width = column_0->WidthRequest + column_1->WidthRequest - column_1_width;
2336
    IM_ASSERT(column_0_width > 0.0f && column_1_width > 0.0f);
2337
    column_0->WidthRequest = column_0_width;
2338
    column_1->WidthRequest = column_1_width;
2339
    if ((column_0->Flags | column_1->Flags) & ImGuiTableColumnFlags_WidthStretch)
2340
        TableUpdateColumnsWeightFromWidth(table);
2341
    table->IsSettingsDirty = true;
2342
}
2343
2344
// Disable clipping then auto-fit, will take 2 frames
2345
// (we don't take a shortcut for unclipped columns to reduce inconsistencies when e.g. resizing multiple columns)
2346
void ImGui::TableSetColumnWidthAutoSingle(ImGuiTable* table, int column_n)
2347
{
2348
    // Single auto width uses auto-fit
2349
    ImGuiTableColumn* column = &table->Columns[column_n];
2350
    if (!column->IsEnabled)
2351
        return;
2352
    column->CannotSkipItemsQueue = (1 << 0);
2353
    table->AutoFitSingleColumn = (ImGuiTableColumnIdx)column_n;
2354
}
2355
2356
void ImGui::TableSetColumnWidthAutoAll(ImGuiTable* table)
2357
{
2358
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2359
    {
2360
        ImGuiTableColumn* column = &table->Columns[column_n];
2361
        if (!column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) // Cannot reset weight of hidden stretch column
2362
            continue;
2363
        column->CannotSkipItemsQueue = (1 << 0);
2364
        column->AutoFitQueue = (1 << 1);
2365
    }
2366
}
2367
2368
void ImGui::TableUpdateColumnsWeightFromWidth(ImGuiTable* table)
2369
{
2370
    IM_ASSERT(table->LeftMostStretchedColumn != -1 && table->RightMostStretchedColumn != -1);
2371
2372
    // Measure existing quantities
2373
    float visible_weight = 0.0f;
2374
    float visible_width = 0.0f;
2375
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2376
    {
2377
        ImGuiTableColumn* column = &table->Columns[column_n];
2378
        if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
2379
            continue;
2380
        IM_ASSERT(column->StretchWeight > 0.0f);
2381
        visible_weight += column->StretchWeight;
2382
        visible_width += column->WidthRequest;
2383
    }
2384
    IM_ASSERT(visible_weight > 0.0f && visible_width > 0.0f);
2385
2386
    // Apply new weights
2387
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2388
    {
2389
        ImGuiTableColumn* column = &table->Columns[column_n];
2390
        if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
2391
            continue;
2392
        column->StretchWeight = (column->WidthRequest / visible_width) * visible_weight;
2393
        IM_ASSERT(column->StretchWeight > 0.0f);
2394
    }
2395
}
2396
2397
//-------------------------------------------------------------------------
2398
// [SECTION] Tables: Drawing
2399
//-------------------------------------------------------------------------
2400
// - TablePushBackgroundChannel() [Internal]
2401
// - TablePopBackgroundChannel() [Internal]
2402
// - TableSetupDrawChannels() [Internal]
2403
// - TableMergeDrawChannels() [Internal]
2404
// - TableGetColumnBorderCol() [Internal]
2405
// - TableDrawBorders() [Internal]
2406
//-------------------------------------------------------------------------
2407
2408
// Bg2 is used by Selectable (and possibly other widgets) to render to the background.
2409
// Unlike our Bg0/1 channel which we uses for RowBg/CellBg/Borders and where we guarantee all shapes to be CPU-clipped, the Bg2 channel being widgets-facing will rely on regular ClipRect.
2410
void ImGui::TablePushBackgroundChannel()
2411
{
2412
    ImGuiContext& g = *GImGui;
2413
    ImGuiWindow* window = g.CurrentWindow;
2414
    ImGuiTable* table = g.CurrentTable;
2415
2416
    // Optimization: avoid SetCurrentChannel() + PushClipRect()
2417
    table->HostBackupInnerClipRect = window->ClipRect;
2418
    SetWindowClipRectBeforeSetChannel(window, table->Bg2ClipRectForDrawCmd);
2419
    table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Bg2DrawChannelCurrent);
2420
}
2421
2422
void ImGui::TablePopBackgroundChannel()
2423
{
2424
    ImGuiContext& g = *GImGui;
2425
    ImGuiWindow* window = g.CurrentWindow;
2426
    ImGuiTable* table = g.CurrentTable;
2427
    ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
2428
2429
    // Optimization: avoid PopClipRect() + SetCurrentChannel()
2430
    SetWindowClipRectBeforeSetChannel(window, table->HostBackupInnerClipRect);
2431
    table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent);
2432
}
2433
2434
// Allocate draw channels. Called by TableUpdateLayout()
2435
// - We allocate them following storage order instead of display order so reordering columns won't needlessly
2436
//   increase overall dormant memory cost.
2437
// - We isolate headers draw commands in their own channels instead of just altering clip rects.
2438
//   This is in order to facilitate merging of draw commands.
2439
// - After crossing FreezeRowsCount, all columns see their current draw channel changed to a second set of channels.
2440
// - We only use the dummy draw channel so we can push a null clipping rectangle into it without affecting other
2441
//   channels, while simplifying per-row/per-cell overhead. It will be empty and discarded when merged.
2442
// - We allocate 1 or 2 background draw channels. This is because we know TablePushBackgroundChannel() is only used for
2443
//   horizontal spanning. If we allowed vertical spanning we'd need one background draw channel per merge group (1-4).
2444
// Draw channel allocation (before merging):
2445
// - NoClip                       --> 2+D+1 channels: bg0/1 + bg2 + foreground (same clip rect == always 1 draw call)
2446
// - Clip                         --> 2+D+N channels
2447
// - FreezeRows                   --> 2+D+N*2 (unless scrolling value is zero)
2448
// - FreezeRows || FreezeColunns  --> 3+D+N*2 (unless scrolling value is zero)
2449
// Where D is 1 if any column is clipped or hidden (dummy channel) otherwise 0.
2450
void ImGui::TableSetupDrawChannels(ImGuiTable* table)
2451
{
2452
    const int freeze_row_multiplier = (table->FreezeRowsCount > 0) ? 2 : 1;
2453
    const int channels_for_row = (table->Flags & ImGuiTableFlags_NoClip) ? 1 : table->ColumnsEnabledCount;
2454
    const int channels_for_bg = 1 + 1 * freeze_row_multiplier;
2455
    const int channels_for_dummy = (table->ColumnsEnabledCount < table->ColumnsCount || (memcmp(table->VisibleMaskByIndex, table->EnabledMaskByIndex, ImBitArrayGetStorageSizeInBytes(table->ColumnsCount)) != 0)) ? +1 : 0;
2456
    const int channels_total = channels_for_bg + (channels_for_row * freeze_row_multiplier) + channels_for_dummy;
2457
    table->DrawSplitter->Split(table->InnerWindow->DrawList, channels_total);
2458
    table->DummyDrawChannel = (ImGuiTableDrawChannelIdx)((channels_for_dummy > 0) ? channels_total - 1 : -1);
2459
    table->Bg2DrawChannelCurrent = TABLE_DRAW_CHANNEL_BG2_FROZEN;
2460
    table->Bg2DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)((table->FreezeRowsCount > 0) ? 2 + channels_for_row : TABLE_DRAW_CHANNEL_BG2_FROZEN);
2461
2462
    int draw_channel_current = 2;
2463
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2464
    {
2465
        ImGuiTableColumn* column = &table->Columns[column_n];
2466
        if (column->IsVisibleX && column->IsVisibleY)
2467
        {
2468
            column->DrawChannelFrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current);
2469
            column->DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current + (table->FreezeRowsCount > 0 ? channels_for_row + 1 : 0));
2470
            if (!(table->Flags & ImGuiTableFlags_NoClip))
2471
                draw_channel_current++;
2472
        }
2473
        else
2474
        {
2475
            column->DrawChannelFrozen = column->DrawChannelUnfrozen = table->DummyDrawChannel;
2476
        }
2477
        column->DrawChannelCurrent = column->DrawChannelFrozen;
2478
    }
2479
2480
    // Initial draw cmd starts with a BgClipRect that matches the one of its host, to facilitate merge draw commands by default.
2481
    // All our cell highlight are manually clipped with BgClipRect. When unfreezing it will be made smaller to fit scrolling rect.
2482
    // (This technically isn't part of setting up draw channels, but is reasonably related to be done here)
2483
    table->BgClipRect = table->InnerClipRect;
2484
    table->Bg0ClipRectForDrawCmd = table->OuterWindow->ClipRect;
2485
    table->Bg2ClipRectForDrawCmd = table->HostClipRect;
2486
    IM_ASSERT(table->BgClipRect.Min.y <= table->BgClipRect.Max.y);
2487
}
2488
2489
// This function reorder draw channels based on matching clip rectangle, to facilitate merging them. Called by EndTable().
2490
// For simplicity we call it TableMergeDrawChannels() but in fact it only reorder channels + overwrite ClipRect,
2491
// actual merging is done by table->DrawSplitter.Merge() which is called right after TableMergeDrawChannels().
2492
//
2493
// Columns where the contents didn't stray off their local clip rectangle can be merged. To achieve
2494
// this we merge their clip rect and make them contiguous in the channel list, so they can be merged
2495
// by the call to DrawSplitter.Merge() following to the call to this function.
2496
// We reorder draw commands by arranging them into a maximum of 4 distinct groups:
2497
//
2498
//   1 group:               2 groups:              2 groups:              4 groups:
2499
//   [ 0. ] no freeze       [ 0. ] row freeze      [ 01 ] col freeze      [ 01 ] row+col freeze
2500
//   [ .. ]  or no scroll   [ 2. ]  and v-scroll   [ .. ]  and h-scroll   [ 23 ]  and v+h-scroll
2501
//
2502
// Each column itself can use 1 channel (row freeze disabled) or 2 channels (row freeze enabled).
2503
// When the contents of a column didn't stray off its limit, we move its channels into the corresponding group
2504
// based on its position (within frozen rows/columns groups or not).
2505
// At the end of the operation our 1-4 groups will each have a ImDrawCmd using the same ClipRect.
2506
// This function assume that each column are pointing to a distinct draw channel,
2507
// otherwise merge_group->ChannelsCount will not match set bit count of merge_group->ChannelsMask.
2508
//
2509
// Column channels will not be merged into one of the 1-4 groups in the following cases:
2510
// - The contents stray off its clipping rectangle (we only compare the MaxX value, not the MinX value).
2511
//   Direct ImDrawList calls won't be taken into account by default, if you use them make sure the ImGui:: bounds
2512
//   matches, by e.g. calling SetCursorScreenPos().
2513
// - The channel uses more than one draw command itself. We drop all our attempt at merging stuff here..
2514
//   we could do better but it's going to be rare and probably not worth the hassle.
2515
// Columns for which the draw channel(s) haven't been merged with other will use their own ImDrawCmd.
2516
//
2517
// This function is particularly tricky to understand.. take a breath.
2518
void ImGui::TableMergeDrawChannels(ImGuiTable* table)
2519
{
2520
    ImGuiContext& g = *GImGui;
2521
    ImDrawListSplitter* splitter = table->DrawSplitter;
2522
    const bool has_freeze_v = (table->FreezeRowsCount > 0);
2523
    const bool has_freeze_h = (table->FreezeColumnsCount > 0);
2524
    IM_ASSERT(splitter->_Current == 0);
2525
2526
    // Track which groups we are going to attempt to merge, and which channels goes into each group.
2527
    struct MergeGroup
2528
    {
2529
        ImRect          ClipRect;
2530
        int             ChannelsCount = 0;
2531
        ImBitArrayPtr   ChannelsMask = NULL;
2532
    };
2533
    int merge_group_mask = 0x00;
2534
    MergeGroup merge_groups[4];
2535
2536
    // Use a reusable temp buffer for the merge masks as they are dynamically sized.
2537
    const int max_draw_channels = (4 + table->ColumnsCount * 2);
2538
    const int size_for_masks_bitarrays_one = (int)ImBitArrayGetStorageSizeInBytes(max_draw_channels);
2539
    g.TempBuffer.reserve(size_for_masks_bitarrays_one * 5);
2540
    memset(g.TempBuffer.Data, 0, size_for_masks_bitarrays_one * 5);
2541
    for (int n = 0; n < IM_ARRAYSIZE(merge_groups); n++)
2542
        merge_groups[n].ChannelsMask = (ImBitArrayPtr)(void*)(g.TempBuffer.Data + (size_for_masks_bitarrays_one * n));
2543
    ImBitArrayPtr remaining_mask = (ImBitArrayPtr)(void*)(g.TempBuffer.Data + (size_for_masks_bitarrays_one * 4));
2544
2545
    // 1. Scan channels and take note of those which can be merged
2546
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2547
    {
2548
        if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n))
2549
            continue;
2550
        ImGuiTableColumn* column = &table->Columns[column_n];
2551
2552
        const int merge_group_sub_count = has_freeze_v ? 2 : 1;
2553
        for (int merge_group_sub_n = 0; merge_group_sub_n < merge_group_sub_count; merge_group_sub_n++)
2554
        {
2555
            const int channel_no = (merge_group_sub_n == 0) ? column->DrawChannelFrozen : column->DrawChannelUnfrozen;
2556
2557
            // Don't attempt to merge if there are multiple draw calls within the column
2558
            ImDrawChannel* src_channel = &splitter->_Channels[channel_no];
2559
            if (src_channel->_CmdBuffer.Size > 0 && src_channel->_CmdBuffer.back().ElemCount == 0 && src_channel->_CmdBuffer.back().UserCallback == NULL) // Equivalent of PopUnusedDrawCmd()
2560
                src_channel->_CmdBuffer.pop_back();
2561
            if (src_channel->_CmdBuffer.Size != 1)
2562
                continue;
2563
2564
            // Find out the width of this merge group and check if it will fit in our column
2565
            // (note that we assume that rendering didn't stray on the left direction. we should need a CursorMinPos to detect it)
2566
            if (!(column->Flags & ImGuiTableColumnFlags_NoClip))
2567
            {
2568
                float content_max_x;
2569
                if (!has_freeze_v)
2570
                    content_max_x = ImMax(column->ContentMaxXUnfrozen, column->ContentMaxXHeadersUsed); // No row freeze
2571
                else if (merge_group_sub_n == 0)
2572
                    content_max_x = ImMax(column->ContentMaxXFrozen, column->ContentMaxXHeadersUsed);   // Row freeze: use width before freeze
2573
                else
2574
                    content_max_x = column->ContentMaxXUnfrozen;                                        // Row freeze: use width after freeze
2575
                if (content_max_x > column->ClipRect.Max.x)
2576
                    continue;
2577
            }
2578
2579
            const int merge_group_n = (has_freeze_h && column_n < table->FreezeColumnsCount ? 0 : 1) + (has_freeze_v && merge_group_sub_n == 0 ? 0 : 2);
2580
            IM_ASSERT(channel_no < max_draw_channels);
2581
            MergeGroup* merge_group = &merge_groups[merge_group_n];
2582
            if (merge_group->ChannelsCount == 0)
2583
                merge_group->ClipRect = ImRect(+FLT_MAX, +FLT_MAX, -FLT_MAX, -FLT_MAX);
2584
            ImBitArraySetBit(merge_group->ChannelsMask, channel_no);
2585
            merge_group->ChannelsCount++;
2586
            merge_group->ClipRect.Add(src_channel->_CmdBuffer[0].ClipRect);
2587
            merge_group_mask |= (1 << merge_group_n);
2588
        }
2589
2590
        // Invalidate current draw channel
2591
        // (we don't clear DrawChannelFrozen/DrawChannelUnfrozen solely to facilitate debugging/later inspection of data)
2592
        column->DrawChannelCurrent = (ImGuiTableDrawChannelIdx)-1;
2593
    }
2594
2595
    // [DEBUG] Display merge groups
2596
#if 0
2597
    if (g.IO.KeyShift)
2598
        for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++)
2599
        {
2600
            MergeGroup* merge_group = &merge_groups[merge_group_n];
2601
            if (merge_group->ChannelsCount == 0)
2602
                continue;
2603
            char buf[32];
2604
            ImFormatString(buf, 32, "MG%d:%d", merge_group_n, merge_group->ChannelsCount);
2605
            ImVec2 text_pos = merge_group->ClipRect.Min + ImVec2(4, 4);
2606
            ImVec2 text_size = CalcTextSize(buf, NULL);
2607
            GetForegroundDrawList()->AddRectFilled(text_pos, text_pos + text_size, IM_COL32(0, 0, 0, 255));
2608
            GetForegroundDrawList()->AddText(text_pos, IM_COL32(255, 255, 0, 255), buf, NULL);
2609
            GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 255, 0, 255));
2610
        }
2611
#endif
2612
2613
    // 2. Rewrite channel list in our preferred order
2614
    if (merge_group_mask != 0)
2615
    {
2616
        // We skip channel 0 (Bg0/Bg1) and 1 (Bg2 frozen) from the shuffling since they won't move - see channels allocation in TableSetupDrawChannels().
2617
        const int LEADING_DRAW_CHANNELS = 2;
2618
        g.DrawChannelsTempMergeBuffer.resize(splitter->_Count - LEADING_DRAW_CHANNELS); // Use shared temporary storage so the allocation gets amortized
2619
        ImDrawChannel* dst_tmp = g.DrawChannelsTempMergeBuffer.Data;
2620
        ImBitArraySetBitRange(remaining_mask, LEADING_DRAW_CHANNELS, splitter->_Count);
2621
        ImBitArrayClearBit(remaining_mask, table->Bg2DrawChannelUnfrozen);
2622
        IM_ASSERT(has_freeze_v == false || table->Bg2DrawChannelUnfrozen != TABLE_DRAW_CHANNEL_BG2_FROZEN);
2623
        int remaining_count = splitter->_Count - (has_freeze_v ? LEADING_DRAW_CHANNELS + 1 : LEADING_DRAW_CHANNELS);
2624
        //ImRect host_rect = (table->InnerWindow == table->OuterWindow) ? table->InnerClipRect : table->HostClipRect;
2625
        ImRect host_rect = table->HostClipRect;
2626
        for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++)
2627
        {
2628
            if (int merge_channels_count = merge_groups[merge_group_n].ChannelsCount)
2629
            {
2630
                MergeGroup* merge_group = &merge_groups[merge_group_n];
2631
                ImRect merge_clip_rect = merge_group->ClipRect;
2632
2633
                // Extend outer-most clip limits to match those of host, so draw calls can be merged even if
2634
                // outer-most columns have some outer padding offsetting them from their parent ClipRect.
2635
                // The principal cases this is dealing with are:
2636
                // - On a same-window table (not scrolling = single group), all fitting columns ClipRect -> will extend and match host ClipRect -> will merge
2637
                // - Columns can use padding and have left-most ClipRect.Min.x and right-most ClipRect.Max.x != from host ClipRect -> will extend and match host ClipRect -> will merge
2638
                // FIXME-TABLE FIXME-WORKRECT: We are wasting a merge opportunity on tables without scrolling if column doesn't fit
2639
                // within host clip rect, solely because of the half-padding difference between window->WorkRect and window->InnerClipRect.
2640
                if ((merge_group_n & 1) == 0 || !has_freeze_h)
2641
                    merge_clip_rect.Min.x = ImMin(merge_clip_rect.Min.x, host_rect.Min.x);
2642
                if ((merge_group_n & 2) == 0 || !has_freeze_v)
2643
                    merge_clip_rect.Min.y = ImMin(merge_clip_rect.Min.y, host_rect.Min.y);
2644
                if ((merge_group_n & 1) != 0)
2645
                    merge_clip_rect.Max.x = ImMax(merge_clip_rect.Max.x, host_rect.Max.x);
2646
                if ((merge_group_n & 2) != 0 && (table->Flags & ImGuiTableFlags_NoHostExtendY) == 0)
2647
                    merge_clip_rect.Max.y = ImMax(merge_clip_rect.Max.y, host_rect.Max.y);
2648
                //GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 0, 0, 200), 0.0f, 0, 1.0f); // [DEBUG]
2649
                //GetForegroundDrawList()->AddLine(merge_group->ClipRect.Min, merge_clip_rect.Min, IM_COL32(255, 100, 0, 200));
2650
                //GetForegroundDrawList()->AddLine(merge_group->ClipRect.Max, merge_clip_rect.Max, IM_COL32(255, 100, 0, 200));
2651
                remaining_count -= merge_group->ChannelsCount;
2652
                for (int n = 0; n < (size_for_masks_bitarrays_one >> 2); n++)
2653
                    remaining_mask[n] &= ~merge_group->ChannelsMask[n];
2654
                for (int n = 0; n < splitter->_Count && merge_channels_count != 0; n++)
2655
                {
2656
                    // Copy + overwrite new clip rect
2657
                    if (!IM_BITARRAY_TESTBIT(merge_group->ChannelsMask, n))
2658
                        continue;
2659
                    IM_BITARRAY_CLEARBIT(merge_group->ChannelsMask, n);
2660
                    merge_channels_count--;
2661
2662
                    ImDrawChannel* channel = &splitter->_Channels[n];
2663
                    IM_ASSERT(channel->_CmdBuffer.Size == 1 && merge_clip_rect.Contains(ImRect(channel->_CmdBuffer[0].ClipRect)));
2664
                    channel->_CmdBuffer[0].ClipRect = merge_clip_rect.ToVec4();
2665
                    memcpy(dst_tmp++, channel, sizeof(ImDrawChannel));
2666
                }
2667
            }
2668
2669
            // Make sure Bg2DrawChannelUnfrozen appears in the middle of our groups (whereas Bg0/Bg1 and Bg2 frozen are fixed to 0 and 1)
2670
            if (merge_group_n == 1 && has_freeze_v)
2671
                memcpy(dst_tmp++, &splitter->_Channels[table->Bg2DrawChannelUnfrozen], sizeof(ImDrawChannel));
2672
        }
2673
2674
        // Append unmergeable channels that we didn't reorder at the end of the list
2675
        for (int n = 0; n < splitter->_Count && remaining_count != 0; n++)
2676
        {
2677
            if (!IM_BITARRAY_TESTBIT(remaining_mask, n))
2678
                continue;
2679
            ImDrawChannel* channel = &splitter->_Channels[n];
2680
            memcpy(dst_tmp++, channel, sizeof(ImDrawChannel));
2681
            remaining_count--;
2682
        }
2683
        IM_ASSERT(dst_tmp == g.DrawChannelsTempMergeBuffer.Data + g.DrawChannelsTempMergeBuffer.Size);
2684
        memcpy(splitter->_Channels.Data + LEADING_DRAW_CHANNELS, g.DrawChannelsTempMergeBuffer.Data, (splitter->_Count - LEADING_DRAW_CHANNELS) * sizeof(ImDrawChannel));
2685
    }
2686
}
2687
2688
static ImU32 TableGetColumnBorderCol(ImGuiTable* table, int order_n, int column_n)
2689
{
2690
    const bool is_hovered = (table->HoveredColumnBorder == column_n);
2691
    const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent);
2692
    const bool is_frozen_separator = (table->FreezeColumnsCount == order_n + 1);
2693
    if (is_resized || is_hovered)
2694
        return ImGui::GetColorU32(is_resized ? ImGuiCol_SeparatorActive : ImGuiCol_SeparatorHovered);
2695
    if (is_frozen_separator || (table->Flags & (ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_NoBordersInBodyUntilResize)))
2696
        return table->BorderColorStrong;
2697
    return table->BorderColorLight;
2698
}
2699
2700
// FIXME-TABLE: This is a mess, need to redesign how we render borders (as some are also done in TableEndRow)
2701
void ImGui::TableDrawBorders(ImGuiTable* table)
2702
{
2703
    ImGuiWindow* inner_window = table->InnerWindow;
2704
    if (!table->OuterWindow->ClipRect.Overlaps(table->OuterRect))
2705
        return;
2706
2707
    ImDrawList* inner_drawlist = inner_window->DrawList;
2708
    table->DrawSplitter->SetCurrentChannel(inner_drawlist, TABLE_DRAW_CHANNEL_BG0);
2709
    inner_drawlist->PushClipRect(table->Bg0ClipRectForDrawCmd.Min, table->Bg0ClipRectForDrawCmd.Max, false);
2710
2711
    // Draw inner border and resizing feedback
2712
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
2713
    const float border_size = TABLE_BORDER_SIZE;
2714
    const float draw_y1 = ImMax(table->InnerRect.Min.y, (table->FreezeRowsCount >= 1 ? table->InnerRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight) + ((table->Flags & ImGuiTableFlags_BordersOuterH) ? 1.0f : 0.0f);
2715
    const float draw_y2_body = table->InnerRect.Max.y;
2716
    const float draw_y2_head = table->IsUsingHeaders ? ImMin(table->InnerRect.Max.y, (table->FreezeRowsCount >= 1 ? table->InnerRect.Min.y : table->WorkRect.Min.y) + table_instance->LastTopHeadersRowHeight) : draw_y1;
2717
    if (table->Flags & ImGuiTableFlags_BordersInnerV)
2718
    {
2719
        for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
2720
        {
2721
            if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
2722
                continue;
2723
2724
            const int column_n = table->DisplayOrderToIndex[order_n];
2725
            ImGuiTableColumn* column = &table->Columns[column_n];
2726
            const bool is_hovered = (table->HoveredColumnBorder == column_n);
2727
            const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent);
2728
            const bool is_resizable = (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_)) == 0;
2729
            const bool is_frozen_separator = (table->FreezeColumnsCount == order_n + 1);
2730
            if (column->MaxX > table->InnerClipRect.Max.x && !is_resized)
2731
                continue;
2732
2733
            // Decide whether right-most column is visible
2734
            if (column->NextEnabledColumn == -1 && !is_resizable)
2735
                if ((table->Flags & ImGuiTableFlags_SizingMask_) != ImGuiTableFlags_SizingFixedSame || (table->Flags & ImGuiTableFlags_NoHostExtendX))
2736
                    continue;
2737
            if (column->MaxX <= column->ClipRect.Min.x) // FIXME-TABLE FIXME-STYLE: Assume BorderSize==1, this is problematic if we want to increase the border size..
2738
                continue;
2739
2740
            // Draw in outer window so right-most column won't be clipped
2741
            // Always draw full height border when being resized/hovered, or on the delimitation of frozen column scrolling.
2742
            float draw_y2 = (is_hovered || is_resized || is_frozen_separator || (table->Flags & (ImGuiTableFlags_NoBordersInBody | ImGuiTableFlags_NoBordersInBodyUntilResize)) == 0) ? draw_y2_body : draw_y2_head;
2743
            if (draw_y2 > draw_y1)
2744
                inner_drawlist->AddLine(ImVec2(column->MaxX, draw_y1), ImVec2(column->MaxX, draw_y2), TableGetColumnBorderCol(table, order_n, column_n), border_size);
2745
        }
2746
    }
2747
2748
    // Draw outer border
2749
    // FIXME: could use AddRect or explicit VLine/HLine helper?
2750
    if (table->Flags & ImGuiTableFlags_BordersOuter)
2751
    {
2752
        // Display outer border offset by 1 which is a simple way to display it without adding an extra draw call
2753
        // (Without the offset, in outer_window it would be rendered behind cells, because child windows are above their
2754
        // parent. In inner_window, it won't reach out over scrollbars. Another weird solution would be to display part
2755
        // of it in inner window, and the part that's over scrollbars in the outer window..)
2756
        // Either solution currently won't allow us to use a larger border size: the border would clipped.
2757
        const ImRect outer_border = table->OuterRect;
2758
        const ImU32 outer_col = table->BorderColorStrong;
2759
        if ((table->Flags & ImGuiTableFlags_BordersOuter) == ImGuiTableFlags_BordersOuter)
2760
        {
2761
            inner_drawlist->AddRect(outer_border.Min, outer_border.Max, outer_col, 0.0f, 0, border_size);
2762
        }
2763
        else if (table->Flags & ImGuiTableFlags_BordersOuterV)
2764
        {
2765
            inner_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Min.x, outer_border.Max.y), outer_col, border_size);
2766
            inner_drawlist->AddLine(ImVec2(outer_border.Max.x, outer_border.Min.y), outer_border.Max, outer_col, border_size);
2767
        }
2768
        else if (table->Flags & ImGuiTableFlags_BordersOuterH)
2769
        {
2770
            inner_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Max.x, outer_border.Min.y), outer_col, border_size);
2771
            inner_drawlist->AddLine(ImVec2(outer_border.Min.x, outer_border.Max.y), outer_border.Max, outer_col, border_size);
2772
        }
2773
    }
2774
    if ((table->Flags & ImGuiTableFlags_BordersInnerH) && table->RowPosY2 < table->OuterRect.Max.y)
2775
    {
2776
        // Draw bottom-most row border between it is above outer border.
2777
        const float border_y = table->RowPosY2;
2778
        if (border_y >= table->BgClipRect.Min.y && border_y < table->BgClipRect.Max.y)
2779
            inner_drawlist->AddLine(ImVec2(table->BorderX1, border_y), ImVec2(table->BorderX2, border_y), table->BorderColorLight, border_size);
2780
    }
2781
2782
    inner_drawlist->PopClipRect();
2783
}
2784
2785
//-------------------------------------------------------------------------
2786
// [SECTION] Tables: Sorting
2787
//-------------------------------------------------------------------------
2788
// - TableGetSortSpecs()
2789
// - TableFixColumnSortDirection() [Internal]
2790
// - TableGetColumnNextSortDirection() [Internal]
2791
// - TableSetColumnSortDirection() [Internal]
2792
// - TableSortSpecsSanitize() [Internal]
2793
// - TableSortSpecsBuild() [Internal]
2794
//-------------------------------------------------------------------------
2795
2796
// Return NULL if no sort specs (most often when ImGuiTableFlags_Sortable is not set)
2797
// When 'sort_specs->SpecsDirty == true' you should sort your data. It will be true when sorting specs have
2798
// changed since last call, or the first time. Make sure to set 'SpecsDirty = false' after sorting,
2799
// else you may wastefully sort your data every frame!
2800
// Lifetime: don't hold on this pointer over multiple frames or past any subsequent call to BeginTable()!
2801
ImGuiTableSortSpecs* ImGui::TableGetSortSpecs()
2802
{
2803
    ImGuiContext& g = *GImGui;
2804
    ImGuiTable* table = g.CurrentTable;
2805
    IM_ASSERT(table != NULL);
2806
2807
    if (!(table->Flags & ImGuiTableFlags_Sortable))
2808
        return NULL;
2809
2810
    // Require layout (in case TableHeadersRow() hasn't been called) as it may alter IsSortSpecsDirty in some paths.
2811
    if (!table->IsLayoutLocked)
2812
        TableUpdateLayout(table);
2813
2814
    TableSortSpecsBuild(table);
2815
    return &table->SortSpecs;
2816
}
2817
2818
static inline ImGuiSortDirection TableGetColumnAvailSortDirection(ImGuiTableColumn* column, int n)
2819
{
2820
    IM_ASSERT(n < column->SortDirectionsAvailCount);
2821
    return (ImGuiSortDirection)((column->SortDirectionsAvailList >> (n << 1)) & 0x03);
2822
}
2823
2824
// Fix sort direction if currently set on a value which is unavailable (e.g. activating NoSortAscending/NoSortDescending)
2825
void ImGui::TableFixColumnSortDirection(ImGuiTable* table, ImGuiTableColumn* column)
2826
{
2827
    if (column->SortOrder == -1 || (column->SortDirectionsAvailMask & (1 << column->SortDirection)) != 0)
2828
        return;
2829
    column->SortDirection = (ImU8)TableGetColumnAvailSortDirection(column, 0);
2830
    table->IsSortSpecsDirty = true;
2831
}
2832
2833
// Calculate next sort direction that would be set after clicking the column
2834
// - If the PreferSortDescending flag is set, we will default to a Descending direction on the first click.
2835
// - Note that the PreferSortAscending flag is never checked, it is essentially the default and therefore a no-op.
2836
IM_STATIC_ASSERT(ImGuiSortDirection_None == 0 && ImGuiSortDirection_Ascending == 1 && ImGuiSortDirection_Descending == 2);
2837
ImGuiSortDirection ImGui::TableGetColumnNextSortDirection(ImGuiTableColumn* column)
2838
{
2839
    IM_ASSERT(column->SortDirectionsAvailCount > 0);
2840
    if (column->SortOrder == -1)
2841
        return TableGetColumnAvailSortDirection(column, 0);
2842
    for (int n = 0; n < 3; n++)
2843
        if (column->SortDirection == TableGetColumnAvailSortDirection(column, n))
2844
            return TableGetColumnAvailSortDirection(column, (n + 1) % column->SortDirectionsAvailCount);
2845
    IM_ASSERT(0);
2846
    return ImGuiSortDirection_None;
2847
}
2848
2849
// Note that the NoSortAscending/NoSortDescending flags are processed in TableSortSpecsSanitize(), and they may change/revert
2850
// the value of SortDirection. We could technically also do it here but it would be unnecessary and duplicate code.
2851
void ImGui::TableSetColumnSortDirection(int column_n, ImGuiSortDirection sort_direction, bool append_to_sort_specs)
2852
{
2853
    ImGuiContext& g = *GImGui;
2854
    ImGuiTable* table = g.CurrentTable;
2855
2856
    if (!(table->Flags & ImGuiTableFlags_SortMulti))
2857
        append_to_sort_specs = false;
2858
    if (!(table->Flags & ImGuiTableFlags_SortTristate))
2859
        IM_ASSERT(sort_direction != ImGuiSortDirection_None);
2860
2861
    ImGuiTableColumnIdx sort_order_max = 0;
2862
    if (append_to_sort_specs)
2863
        for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++)
2864
            sort_order_max = ImMax(sort_order_max, table->Columns[other_column_n].SortOrder);
2865
2866
    ImGuiTableColumn* column = &table->Columns[column_n];
2867
    column->SortDirection = (ImU8)sort_direction;
2868
    if (column->SortDirection == ImGuiSortDirection_None)
2869
        column->SortOrder = -1;
2870
    else if (column->SortOrder == -1 || !append_to_sort_specs)
2871
        column->SortOrder = append_to_sort_specs ? sort_order_max + 1 : 0;
2872
2873
    for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++)
2874
    {
2875
        ImGuiTableColumn* other_column = &table->Columns[other_column_n];
2876
        if (other_column != column && !append_to_sort_specs)
2877
            other_column->SortOrder = -1;
2878
        TableFixColumnSortDirection(table, other_column);
2879
    }
2880
    table->IsSettingsDirty = true;
2881
    table->IsSortSpecsDirty = true;
2882
}
2883
2884
void ImGui::TableSortSpecsSanitize(ImGuiTable* table)
2885
{
2886
    IM_ASSERT(table->Flags & ImGuiTableFlags_Sortable);
2887
2888
    // Clear SortOrder from hidden column and verify that there's no gap or duplicate.
2889
    int sort_order_count = 0;
2890
    ImU64 sort_order_mask = 0x00;
2891
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2892
    {
2893
        ImGuiTableColumn* column = &table->Columns[column_n];
2894
        if (column->SortOrder != -1 && !column->IsEnabled)
2895
            column->SortOrder = -1;
2896
        if (column->SortOrder == -1)
2897
            continue;
2898
        sort_order_count++;
2899
        sort_order_mask |= ((ImU64)1 << column->SortOrder);
2900
        IM_ASSERT(sort_order_count < (int)sizeof(sort_order_mask) * 8);
2901
    }
2902
2903
    const bool need_fix_linearize = ((ImU64)1 << sort_order_count) != (sort_order_mask + 1);
2904
    const bool need_fix_single_sort_order = (sort_order_count > 1) && !(table->Flags & ImGuiTableFlags_SortMulti);
2905
    if (need_fix_linearize || need_fix_single_sort_order)
2906
    {
2907
        ImU64 fixed_mask = 0x00;
2908
        for (int sort_n = 0; sort_n < sort_order_count; sort_n++)
2909
        {
2910
            // Fix: Rewrite sort order fields if needed so they have no gap or duplicate.
2911
            // (e.g. SortOrder 0 disappeared, SortOrder 1..2 exists --> rewrite then as SortOrder 0..1)
2912
            int column_with_smallest_sort_order = -1;
2913
            for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2914
                if ((fixed_mask & ((ImU64)1 << (ImU64)column_n)) == 0 && table->Columns[column_n].SortOrder != -1)
2915
                    if (column_with_smallest_sort_order == -1 || table->Columns[column_n].SortOrder < table->Columns[column_with_smallest_sort_order].SortOrder)
2916
                        column_with_smallest_sort_order = column_n;
2917
            IM_ASSERT(column_with_smallest_sort_order != -1);
2918
            fixed_mask |= ((ImU64)1 << column_with_smallest_sort_order);
2919
            table->Columns[column_with_smallest_sort_order].SortOrder = (ImGuiTableColumnIdx)sort_n;
2920
2921
            // Fix: Make sure only one column has a SortOrder if ImGuiTableFlags_MultiSortable is not set.
2922
            if (need_fix_single_sort_order)
2923
            {
2924
                sort_order_count = 1;
2925
                for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2926
                    if (column_n != column_with_smallest_sort_order)
2927
                        table->Columns[column_n].SortOrder = -1;
2928
                break;
2929
            }
2930
        }
2931
    }
2932
2933
    // Fallback default sort order (if no column with the ImGuiTableColumnFlags_DefaultSort flag)
2934
    if (sort_order_count == 0 && !(table->Flags & ImGuiTableFlags_SortTristate))
2935
        for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2936
        {
2937
            ImGuiTableColumn* column = &table->Columns[column_n];
2938
            if (column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_NoSort))
2939
            {
2940
                sort_order_count = 1;
2941
                column->SortOrder = 0;
2942
                column->SortDirection = (ImU8)TableGetColumnAvailSortDirection(column, 0);
2943
                break;
2944
            }
2945
        }
2946
2947
    table->SortSpecsCount = (ImGuiTableColumnIdx)sort_order_count;
2948
}
2949
2950
void ImGui::TableSortSpecsBuild(ImGuiTable* table)
2951
{
2952
    bool dirty = table->IsSortSpecsDirty;
2953
    if (dirty)
2954
    {
2955
        TableSortSpecsSanitize(table);
2956
        table->SortSpecsMulti.resize(table->SortSpecsCount <= 1 ? 0 : table->SortSpecsCount);
2957
        table->SortSpecs.SpecsDirty = true; // Mark as dirty for user
2958
        table->IsSortSpecsDirty = false; // Mark as not dirty for us
2959
    }
2960
2961
    // Write output
2962
    // May be able to move all SortSpecs data from table (48 bytes) to ImGuiTableTempData if we decide to write it back on every BeginTable()
2963
    ImGuiTableColumnSortSpecs* sort_specs = (table->SortSpecsCount == 0) ? NULL : (table->SortSpecsCount == 1) ? &table->SortSpecsSingle : table->SortSpecsMulti.Data;
2964
    if (dirty && sort_specs != NULL)
2965
        for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
2966
        {
2967
            ImGuiTableColumn* column = &table->Columns[column_n];
2968
            if (column->SortOrder == -1)
2969
                continue;
2970
            IM_ASSERT(column->SortOrder < table->SortSpecsCount);
2971
            ImGuiTableColumnSortSpecs* sort_spec = &sort_specs[column->SortOrder];
2972
            sort_spec->ColumnUserID = column->UserID;
2973
            sort_spec->ColumnIndex = (ImGuiTableColumnIdx)column_n;
2974
            sort_spec->SortOrder = (ImGuiTableColumnIdx)column->SortOrder;
2975
            sort_spec->SortDirection = (ImGuiSortDirection)column->SortDirection;
2976
        }
2977
2978
    table->SortSpecs.Specs = sort_specs;
2979
    table->SortSpecs.SpecsCount = table->SortSpecsCount;
2980
}
2981
2982
//-------------------------------------------------------------------------
2983
// [SECTION] Tables: Headers
2984
//-------------------------------------------------------------------------
2985
// - TableGetHeaderRowHeight() [Internal]
2986
// - TableGetHeaderAngledMaxLabelWidth() [Internal]
2987
// - TableHeadersRow()
2988
// - TableHeader()
2989
// - TableAngledHeadersRow()
2990
// - TableAngledHeadersRowEx() [Internal]
2991
//-------------------------------------------------------------------------
2992
2993
float ImGui::TableGetHeaderRowHeight()
2994
{
2995
    // Caring for a minor edge case:
2996
    // Calculate row height, for the unlikely case that some labels may be taller than others.
2997
    // If we didn't do that, uneven header height would highlight but smaller one before the tallest wouldn't catch input for all height.
2998
    // In your custom header row you may omit this all together and just call TableNextRow() without a height...
2999
    ImGuiContext& g = *GImGui;
3000
    ImGuiTable* table = g.CurrentTable;
3001
    float row_height = g.FontSize;
3002
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3003
        if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
3004
            if ((table->Columns[column_n].Flags & ImGuiTableColumnFlags_NoHeaderLabel) == 0)
3005
                row_height = ImMax(row_height, CalcTextSize(TableGetColumnName(table, column_n)).y);
3006
    return row_height + g.Style.CellPadding.y * 2.0f;
3007
}
3008
3009
float ImGui::TableGetHeaderAngledMaxLabelWidth()
3010
{
3011
    ImGuiContext& g = *GImGui;
3012
    ImGuiTable* table = g.CurrentTable;
3013
    float width = 0.0f;
3014
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3015
        if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n))
3016
            if (table->Columns[column_n].Flags & ImGuiTableColumnFlags_AngledHeader)
3017
                width = ImMax(width, CalcTextSize(TableGetColumnName(table, column_n), NULL, true).x);
3018
    return width + g.Style.CellPadding.y * 2.0f; // Swap padding
3019
}
3020
3021
// [Public] This is a helper to output TableHeader() calls based on the column names declared in TableSetupColumn().
3022
// The intent is that advanced users willing to create customized headers would not need to use this helper
3023
// and can create their own! For example: TableHeader() may be preceded by Checkbox() or other custom widgets.
3024
// See 'Demo->Tables->Custom headers' for a demonstration of implementing a custom version of this.
3025
// This code is intentionally written to not make much use of internal functions, to give you better direction
3026
// if you need to write your own.
3027
// FIXME-TABLE: TableOpenContextMenu() and TableGetHeaderRowHeight() are not public.
3028
void ImGui::TableHeadersRow()
3029
{
3030
    ImGuiContext& g = *GImGui;
3031
    ImGuiTable* table = g.CurrentTable;
3032
    IM_ASSERT(table != NULL && "Need to call TableHeadersRow() after BeginTable()!");
3033
3034
    // Call layout if not already done. This is automatically done by TableNextRow: we do it here _only_ to make
3035
    // it easier to debug-step in TableUpdateLayout(). Your own version of this function doesn't need this.
3036
    if (!table->IsLayoutLocked)
3037
        TableUpdateLayout(table);
3038
3039
    // Open row
3040
    const float row_height = TableGetHeaderRowHeight();
3041
    TableNextRow(ImGuiTableRowFlags_Headers, row_height);
3042
    const float row_y1 = GetCursorScreenPos().y;
3043
    if (table->HostSkipItems) // Merely an optimization, you may skip in your own code.
3044
        return;
3045
3046
    const int columns_count = TableGetColumnCount();
3047
    for (int column_n = 0; column_n < columns_count; column_n++)
3048
    {
3049
        if (!TableSetColumnIndex(column_n))
3050
            continue;
3051
3052
        // Push an id to allow empty/unnamed headers. This is also idiomatic as it ensure there is a consistent ID path to access columns (for e.g. automation)
3053
        const char* name = (TableGetColumnFlags(column_n) & ImGuiTableColumnFlags_NoHeaderLabel) ? "" : TableGetColumnName(column_n);
3054
        PushID(column_n);
3055
        TableHeader(name);
3056
        PopID();
3057
    }
3058
3059
    // Allow opening popup from the right-most section after the last column.
3060
    ImVec2 mouse_pos = ImGui::GetMousePos();
3061
    if (IsMouseReleased(1) && TableGetHoveredColumn() == columns_count)
3062
        if (mouse_pos.y >= row_y1 && mouse_pos.y < row_y1 + row_height)
3063
            TableOpenContextMenu(columns_count); // Will open a non-column-specific popup.
3064
}
3065
3066
// Emit a column header (text + optional sort order)
3067
// We cpu-clip text here so that all columns headers can be merged into a same draw call.
3068
// Note that because of how we cpu-clip and display sorting indicators, you _cannot_ use SameLine() after a TableHeader()
3069
void ImGui::TableHeader(const char* label)
3070
{
3071
    ImGuiContext& g = *GImGui;
3072
    ImGuiWindow* window = g.CurrentWindow;
3073
    if (window->SkipItems)
3074
        return;
3075
3076
    ImGuiTable* table = g.CurrentTable;
3077
    IM_ASSERT(table != NULL && "Need to call TableHeader() after BeginTable()!");
3078
    IM_ASSERT(table->CurrentColumn != -1);
3079
    const int column_n = table->CurrentColumn;
3080
    ImGuiTableColumn* column = &table->Columns[column_n];
3081
3082
    // Label
3083
    if (label == NULL)
3084
        label = "";
3085
    const char* label_end = FindRenderedTextEnd(label);
3086
    ImVec2 label_size = CalcTextSize(label, label_end, true);
3087
    ImVec2 label_pos = window->DC.CursorPos;
3088
3089
    // If we already got a row height, there's use that.
3090
    // FIXME-TABLE: Padding problem if the correct outer-padding CellBgRect strays off our ClipRect?
3091
    ImRect cell_r = TableGetCellBgRect(table, column_n);
3092
    float label_height = ImMax(label_size.y, table->RowMinHeight - table->RowCellPaddingY * 2.0f);
3093
3094
    // Calculate ideal size for sort order arrow
3095
    float w_arrow = 0.0f;
3096
    float w_sort_text = 0.0f;
3097
    bool sort_arrow = false;
3098
    char sort_order_suf[4] = "";
3099
    const float ARROW_SCALE = 0.65f;
3100
    if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort))
3101
    {
3102
        w_arrow = ImTrunc(g.FontSize * ARROW_SCALE + g.Style.FramePadding.x);
3103
        if (column->SortOrder != -1)
3104
            sort_arrow = true;
3105
        if (column->SortOrder > 0)
3106
        {
3107
            ImFormatString(sort_order_suf, IM_ARRAYSIZE(sort_order_suf), "%d", column->SortOrder + 1);
3108
            w_sort_text = g.Style.ItemInnerSpacing.x + CalcTextSize(sort_order_suf).x;
3109
        }
3110
    }
3111
3112
    // We feed our unclipped width to the column without writing on CursorMaxPos, so that column is still considered for merging.
3113
    float max_pos_x = label_pos.x + label_size.x + w_sort_text + w_arrow;
3114
    column->ContentMaxXHeadersUsed = ImMax(column->ContentMaxXHeadersUsed, sort_arrow ? cell_r.Max.x : ImMin(max_pos_x, cell_r.Max.x));
3115
    column->ContentMaxXHeadersIdeal = ImMax(column->ContentMaxXHeadersIdeal, max_pos_x);
3116
3117
    // Keep header highlighted when context menu is open.
3118
    ImGuiID id = window->GetID(label);
3119
    ImRect bb(cell_r.Min.x, cell_r.Min.y, cell_r.Max.x, ImMax(cell_r.Max.y, cell_r.Min.y + label_height + g.Style.CellPadding.y * 2.0f));
3120
    ItemSize(ImVec2(0.0f, label_height)); // Don't declare unclipped width, it'll be fed ContentMaxPosHeadersIdeal
3121
    if (!ItemAdd(bb, id))
3122
        return;
3123
3124
    //GetForegroundDrawList()->AddRect(cell_r.Min, cell_r.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG]
3125
    //GetForegroundDrawList()->AddRect(bb.Min, bb.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG]
3126
3127
    // Using AllowOverlap mode because we cover the whole cell, and we want user to be able to submit subsequent items.
3128
    const bool highlight = (table->HighlightColumnHeader == column_n);
3129
    bool hovered, held;
3130
    bool pressed = ButtonBehavior(bb, id, &hovered, &held, ImGuiButtonFlags_AllowOverlap);
3131
    if (held || hovered || highlight)
3132
    {
3133
        const ImU32 col = GetColorU32(held ? ImGuiCol_HeaderActive : hovered ? ImGuiCol_HeaderHovered : ImGuiCol_Header);
3134
        //RenderFrame(bb.Min, bb.Max, col, false, 0.0f);
3135
        TableSetBgColor(ImGuiTableBgTarget_CellBg, col, table->CurrentColumn);
3136
    }
3137
    else
3138
    {
3139
        // Submit single cell bg color in the case we didn't submit a full header row
3140
        if ((table->RowFlags & ImGuiTableRowFlags_Headers) == 0)
3141
            TableSetBgColor(ImGuiTableBgTarget_CellBg, GetColorU32(ImGuiCol_TableHeaderBg), table->CurrentColumn);
3142
    }
3143
    RenderNavCursor(bb, id, ImGuiNavRenderCursorFlags_Compact | ImGuiNavRenderCursorFlags_NoRounding);
3144
    if (held)
3145
        table->HeldHeaderColumn = (ImGuiTableColumnIdx)column_n;
3146
    window->DC.CursorPos.y -= g.Style.ItemSpacing.y * 0.5f;
3147
3148
    // Drag and drop to re-order columns.
3149
    // FIXME-TABLE: Scroll request while reordering a column and it lands out of the scrolling zone.
3150
    if (held && (table->Flags & ImGuiTableFlags_Reorderable) && IsMouseDragging(0) && !g.DragDropActive)
3151
    {
3152
        // While moving a column it will jump on the other side of the mouse, so we also test for MouseDelta.x
3153
        table->ReorderColumn = (ImGuiTableColumnIdx)column_n;
3154
        table->InstanceInteracted = table->InstanceCurrent;
3155
3156
        // We don't reorder: through the frozen<>unfrozen line, or through a column that is marked with ImGuiTableColumnFlags_NoReorder.
3157
        if (g.IO.MouseDelta.x < 0.0f && g.IO.MousePos.x < cell_r.Min.x)
3158
            if (ImGuiTableColumn* prev_column = (column->PrevEnabledColumn != -1) ? &table->Columns[column->PrevEnabledColumn] : NULL)
3159
                if (!((column->Flags | prev_column->Flags) & ImGuiTableColumnFlags_NoReorder))
3160
                    if ((column->IndexWithinEnabledSet < table->FreezeColumnsRequest) == (prev_column->IndexWithinEnabledSet < table->FreezeColumnsRequest))
3161
                        table->ReorderColumnDir = -1;
3162
        if (g.IO.MouseDelta.x > 0.0f && g.IO.MousePos.x > cell_r.Max.x)
3163
            if (ImGuiTableColumn* next_column = (column->NextEnabledColumn != -1) ? &table->Columns[column->NextEnabledColumn] : NULL)
3164
                if (!((column->Flags | next_column->Flags) & ImGuiTableColumnFlags_NoReorder))
3165
                    if ((column->IndexWithinEnabledSet < table->FreezeColumnsRequest) == (next_column->IndexWithinEnabledSet < table->FreezeColumnsRequest))
3166
                        table->ReorderColumnDir = +1;
3167
    }
3168
3169
    // Sort order arrow
3170
    const float ellipsis_max = ImMax(cell_r.Max.x - w_arrow - w_sort_text, label_pos.x);
3171
    if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort))
3172
    {
3173
        if (column->SortOrder != -1)
3174
        {
3175
            float x = ImMax(cell_r.Min.x, cell_r.Max.x - w_arrow - w_sort_text);
3176
            float y = label_pos.y;
3177
            if (column->SortOrder > 0)
3178
            {
3179
                PushStyleColor(ImGuiCol_Text, GetColorU32(ImGuiCol_Text, 0.70f));
3180
                RenderText(ImVec2(x + g.Style.ItemInnerSpacing.x, y), sort_order_suf);
3181
                PopStyleColor();
3182
                x += w_sort_text;
3183
            }
3184
            RenderArrow(window->DrawList, ImVec2(x, y), GetColorU32(ImGuiCol_Text), column->SortDirection == ImGuiSortDirection_Ascending ? ImGuiDir_Up : ImGuiDir_Down, ARROW_SCALE);
3185
        }
3186
3187
        // Handle clicking on column header to adjust Sort Order
3188
        if (pressed && table->ReorderColumn != column_n)
3189
        {
3190
            ImGuiSortDirection sort_direction = TableGetColumnNextSortDirection(column);
3191
            TableSetColumnSortDirection(column_n, sort_direction, g.IO.KeyShift);
3192
        }
3193
    }
3194
3195
    // Render clipped label. Clipping here ensure that in the majority of situations, all our header cells will
3196
    // be merged into a single draw call.
3197
    //window->DrawList->AddCircleFilled(ImVec2(ellipsis_max, label_pos.y), 40, IM_COL32_WHITE);
3198
    RenderTextEllipsis(window->DrawList, label_pos, ImVec2(ellipsis_max, label_pos.y + label_height + g.Style.FramePadding.y), ellipsis_max, ellipsis_max, label, label_end, &label_size);
3199
3200
    const bool text_clipped = label_size.x > (ellipsis_max - label_pos.x);
3201
    if (text_clipped && hovered && g.ActiveId == 0)
3202
        SetItemTooltip("%.*s", (int)(label_end - label), label);
3203
3204
    // We don't use BeginPopupContextItem() because we want the popup to stay up even after the column is hidden
3205
    if (IsMouseReleased(1) && IsItemHovered())
3206
        TableOpenContextMenu(column_n);
3207
}
3208
3209
// Unlike TableHeadersRow() it is not expected that you can reimplement or customize this with custom widgets.
3210
// FIXME: No hit-testing/button on the angled header.
3211
void ImGui::TableAngledHeadersRow()
3212
{
3213
    ImGuiContext& g = *GImGui;
3214
    ImGuiTable* table = g.CurrentTable;
3215
    ImGuiTableTempData* temp_data = table->TempData;
3216
    temp_data->AngledHeadersRequests.resize(0);
3217
    temp_data->AngledHeadersRequests.reserve(table->ColumnsEnabledCount);
3218
3219
    // Which column needs highlight?
3220
    const ImGuiID row_id = GetID("##AngledHeaders");
3221
    ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent);
3222
    int highlight_column_n = table->HighlightColumnHeader;
3223
    if (highlight_column_n == -1 && table->HoveredColumnBody != -1)
3224
        if (table_instance->HoveredRowLast == 0 && table->HoveredColumnBorder == -1 && (g.ActiveId == 0 || g.ActiveId == row_id || (table->IsActiveIdInTable || g.DragDropActive)))
3225
            highlight_column_n = table->HoveredColumnBody;
3226
3227
    // Build up request
3228
    ImU32 col_header_bg = GetColorU32(ImGuiCol_TableHeaderBg);
3229
    ImU32 col_text = GetColorU32(ImGuiCol_Text);
3230
    for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
3231
        if (IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n))
3232
        {
3233
            const int column_n = table->DisplayOrderToIndex[order_n];
3234
            ImGuiTableColumn* column = &table->Columns[column_n];
3235
            if ((column->Flags & ImGuiTableColumnFlags_AngledHeader) == 0) // Note: can't rely on ImGuiTableColumnFlags_IsVisible test here.
3236
                continue;
3237
            ImGuiTableHeaderData request = { (ImGuiTableColumnIdx)column_n, col_text, col_header_bg, (column_n == highlight_column_n) ? GetColorU32(ImGuiCol_Header) : 0 };
3238
            temp_data->AngledHeadersRequests.push_back(request);
3239
        }
3240
3241
    // Render row
3242
    TableAngledHeadersRowEx(row_id, g.Style.TableAngledHeadersAngle, 0.0f, temp_data->AngledHeadersRequests.Data, temp_data->AngledHeadersRequests.Size);
3243
}
3244
3245
// Important: data must be fed left to right
3246
void ImGui::TableAngledHeadersRowEx(ImGuiID row_id, float angle, float max_label_width, const ImGuiTableHeaderData* data, int data_count)
3247
{
3248
    ImGuiContext& g = *GImGui;
3249
    ImGuiTable* table = g.CurrentTable;
3250
    ImGuiWindow* window = g.CurrentWindow;
3251
    ImDrawList* draw_list = window->DrawList;
3252
    IM_ASSERT(table != NULL && "Need to call TableHeadersRow() after BeginTable()!");
3253
    IM_ASSERT(table->CurrentRow == -1 && "Must be first row");
3254
3255
    if (max_label_width == 0.0f)
3256
        max_label_width = TableGetHeaderAngledMaxLabelWidth();
3257
3258
    // Angle argument expressed in (-IM_PI/2 .. +IM_PI/2) as it is easier to think about for user.
3259
    const bool flip_label = (angle < 0.0f);
3260
    angle -= IM_PI * 0.5f;
3261
    const float cos_a = ImCos(angle);
3262
    const float sin_a = ImSin(angle);
3263
    const float label_cos_a = flip_label ? ImCos(angle + IM_PI) : cos_a;
3264
    const float label_sin_a = flip_label ? ImSin(angle + IM_PI) : sin_a;
3265
    const ImVec2 unit_right = ImVec2(cos_a, sin_a);
3266
3267
    // Calculate our base metrics and set angled headers data _before_ the first call to TableNextRow()
3268
    // FIXME-STYLE: Would it be better for user to submit 'max_label_width' or 'row_height' ? One can be derived from the other.
3269
    const float header_height = g.FontSize + g.Style.CellPadding.x * 2.0f;
3270
    const float row_height = ImTrunc(ImFabs(ImRotate(ImVec2(max_label_width, flip_label ? +header_height : -header_height), cos_a, sin_a).y));
3271
    table->AngledHeadersHeight = row_height;
3272
    table->AngledHeadersSlope = (sin_a != 0.0f) ? (cos_a / sin_a) : 0.0f;
3273
    const ImVec2 header_angled_vector = unit_right * (row_height / -sin_a); // vector from bottom-left to top-left, and from bottom-right to top-right
3274
3275
    // Declare row, override and draw our own background
3276
    TableNextRow(ImGuiTableRowFlags_Headers, row_height);
3277
    TableNextColumn();
3278
    const ImRect row_r(table->WorkRect.Min.x, table->BgClipRect.Min.y, table->WorkRect.Max.x, table->RowPosY2);
3279
    table->DrawSplitter->SetCurrentChannel(draw_list, TABLE_DRAW_CHANNEL_BG0);
3280
    float clip_rect_min_x = table->BgClipRect.Min.x;
3281
    if (table->FreezeColumnsCount > 0)
3282
        clip_rect_min_x = ImMax(clip_rect_min_x, table->Columns[table->FreezeColumnsCount - 1].MaxX);
3283
    TableSetBgColor(ImGuiTableBgTarget_RowBg0, 0); // Cancel
3284
    PushClipRect(table->BgClipRect.Min, table->BgClipRect.Max, false); // Span all columns
3285
    draw_list->AddRectFilled(ImVec2(table->BgClipRect.Min.x, row_r.Min.y), ImVec2(table->BgClipRect.Max.x, row_r.Max.y), GetColorU32(ImGuiCol_TableHeaderBg, 0.25f)); // FIXME-STYLE: Change row background with an arbitrary color.
3286
    PushClipRect(ImVec2(clip_rect_min_x, table->BgClipRect.Min.y), table->BgClipRect.Max, true); // Span all columns
3287
3288
    ButtonBehavior(row_r, row_id, NULL, NULL);
3289
    KeepAliveID(row_id);
3290
3291
    const float ascent_scaled = g.Font->Ascent * g.FontScale; // FIXME: Standardize those scaling factors better
3292
    const float line_off_for_ascent_x = (ImMax((g.FontSize - ascent_scaled) * 0.5f, 0.0f) / -sin_a) * (flip_label ? -1.0f : 1.0f);
3293
    const ImVec2 padding = g.Style.CellPadding; // We will always use swapped component
3294
    const ImVec2 align = g.Style.TableAngledHeadersTextAlign;
3295
3296
    // Draw background and labels in first pass, then all borders.
3297
    float max_x = 0.0f;
3298
    for (int pass = 0; pass < 2; pass++)
3299
        for (int order_n = 0; order_n < data_count; order_n++)
3300
        {
3301
            const ImGuiTableHeaderData* request = &data[order_n];
3302
            const int column_n = request->Index;
3303
            ImGuiTableColumn* column = &table->Columns[column_n];
3304
3305
            ImVec2 bg_shape[4];
3306
            bg_shape[0] = ImVec2(column->MaxX, row_r.Max.y);
3307
            bg_shape[1] = ImVec2(column->MinX, row_r.Max.y);
3308
            bg_shape[2] = bg_shape[1] + header_angled_vector;
3309
            bg_shape[3] = bg_shape[0] + header_angled_vector;
3310
            if (pass == 0)
3311
            {
3312
                // Draw shape
3313
                draw_list->AddQuadFilled(bg_shape[0], bg_shape[1], bg_shape[2], bg_shape[3], request->BgColor0);
3314
                draw_list->AddQuadFilled(bg_shape[0], bg_shape[1], bg_shape[2], bg_shape[3], request->BgColor1); // Optional highlight
3315
                max_x = ImMax(max_x, bg_shape[3].x);
3316
3317
                // Draw label
3318
                // - First draw at an offset where RenderTextXXX() function won't meddle with applying current ClipRect, then transform to final offset.
3319
                // - Handle multiple lines manually, as we want each lines to follow on the horizontal border, rather than see a whole block rotated.
3320
                const char* label_name = TableGetColumnName(table, column_n);
3321
                const char* label_name_end = FindRenderedTextEnd(label_name);
3322
                const float line_off_step_x = (g.FontSize / -sin_a);
3323
                const int label_lines = ImTextCountLines(label_name, label_name_end);
3324
3325
                // Left<>Right alignment
3326
                float line_off_curr_x = flip_label ? (label_lines - 1) * line_off_step_x : 0.0f;
3327
                float line_off_for_align_x = ImMax((((column->MaxX - column->MinX) - padding.x * 2.0f) - (label_lines * line_off_step_x)), 0.0f) * align.x;
3328
                line_off_curr_x += line_off_for_align_x - line_off_for_ascent_x;
3329
3330
                // Register header width
3331
                column->ContentMaxXHeadersUsed = column->ContentMaxXHeadersIdeal = column->WorkMinX + ImCeil(label_lines * line_off_step_x - line_off_for_align_x);
3332
3333
                while (label_name < label_name_end)
3334
                {
3335
                    const char* label_name_eol = strchr(label_name, '\n');
3336
                    if (label_name_eol == NULL)
3337
                        label_name_eol = label_name_end;
3338
3339
                    // FIXME: Individual line clipping for right-most column is broken for negative angles.
3340
                    ImVec2 label_size = CalcTextSize(label_name, label_name_eol);
3341
                    float clip_width = max_label_width - padding.y; // Using padding.y*2.0f would be symmetrical but hide more text.
3342
                    float clip_height = ImMin(label_size.y, column->ClipRect.Max.x - column->WorkMinX - line_off_curr_x);
3343
                    ImRect clip_r(window->ClipRect.Min, window->ClipRect.Min + ImVec2(clip_width, clip_height));
3344
                    int vtx_idx_begin = draw_list->_VtxCurrentIdx;
3345
                    PushStyleColor(ImGuiCol_Text, request->TextColor);
3346
                    RenderTextEllipsis(draw_list, clip_r.Min, clip_r.Max, clip_r.Max.x, clip_r.Max.x, label_name, label_name_eol, &label_size);
3347
                    PopStyleColor();
3348
                    int vtx_idx_end = draw_list->_VtxCurrentIdx;
3349
3350
                    // Up<>Down alignment
3351
                    const float available_space = ImMax(clip_width - label_size.x + ImAbs(padding.x * cos_a) * 2.0f - ImAbs(padding.y * sin_a) * 2.0f, 0.0f);
3352
                    const float vertical_offset = available_space * align.y * (flip_label ? -1.0f : 1.0f);
3353
3354
                    // Rotate and offset label
3355
                    ImVec2 pivot_in = ImVec2(window->ClipRect.Min.x - vertical_offset, window->ClipRect.Min.y + label_size.y);
3356
                    ImVec2 pivot_out = ImVec2(column->WorkMinX, row_r.Max.y);
3357
                    line_off_curr_x += flip_label ? -line_off_step_x : line_off_step_x;
3358
                    pivot_out += unit_right * padding.y;
3359
                    if (flip_label)
3360
                        pivot_out += unit_right * (clip_width - ImMax(0.0f, clip_width - label_size.x));
3361
                    pivot_out.x += flip_label ? line_off_curr_x + line_off_step_x : line_off_curr_x;
3362
                    ShadeVertsTransformPos(draw_list, vtx_idx_begin, vtx_idx_end, pivot_in, label_cos_a, label_sin_a, pivot_out); // Rotate and offset
3363
                    //if (g.IO.KeyShift) { ImDrawList* fg_dl = GetForegroundDrawList(); vtx_idx_begin = fg_dl->_VtxCurrentIdx; fg_dl->AddRect(clip_r.Min, clip_r.Max, IM_COL32(0, 255, 0, 255), 0.0f, 0, 1.0f); ShadeVertsTransformPos(fg_dl, vtx_idx_begin, fg_dl->_VtxCurrentIdx, pivot_in, label_cos_a, label_sin_a, pivot_out); }
3364
3365
                    label_name = label_name_eol + 1;
3366
                }
3367
            }
3368
            if (pass == 1)
3369
            {
3370
                // Draw border
3371
                draw_list->AddLine(bg_shape[0], bg_shape[3], TableGetColumnBorderCol(table, order_n, column_n));
3372
            }
3373
        }
3374
    PopClipRect();
3375
    PopClipRect();
3376
    table->TempData->AngledHeadersExtraWidth = ImMax(0.0f, max_x - table->Columns[table->RightMostEnabledColumn].MaxX);
3377
}
3378
3379
//-------------------------------------------------------------------------
3380
// [SECTION] Tables: Context Menu
3381
//-------------------------------------------------------------------------
3382
// - TableOpenContextMenu() [Internal]
3383
// - TableBeginContextMenuPopup() [Internal]
3384
// - TableDrawDefaultContextMenu() [Internal]
3385
//-------------------------------------------------------------------------
3386
3387
// Use -1 to open menu not specific to a given column.
3388
void ImGui::TableOpenContextMenu(int column_n)
3389
{
3390
    ImGuiContext& g = *GImGui;
3391
    ImGuiTable* table = g.CurrentTable;
3392
    if (column_n == -1 && table->CurrentColumn != -1)   // When called within a column automatically use this one (for consistency)
3393
        column_n = table->CurrentColumn;
3394
    if (column_n == table->ColumnsCount)                // To facilitate using with TableGetHoveredColumn()
3395
        column_n = -1;
3396
    IM_ASSERT(column_n >= -1 && column_n < table->ColumnsCount);
3397
    if (table->Flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable))
3398
    {
3399
        table->IsContextPopupOpen = true;
3400
        table->ContextPopupColumn = (ImGuiTableColumnIdx)column_n;
3401
        table->InstanceInteracted = table->InstanceCurrent;
3402
        const ImGuiID context_menu_id = ImHashStr("##ContextMenu", 0, table->ID);
3403
        OpenPopupEx(context_menu_id, ImGuiPopupFlags_None);
3404
    }
3405
}
3406
3407
bool ImGui::TableBeginContextMenuPopup(ImGuiTable* table)
3408
{
3409
    if (!table->IsContextPopupOpen || table->InstanceCurrent != table->InstanceInteracted)
3410
        return false;
3411
    const ImGuiID context_menu_id = ImHashStr("##ContextMenu", 0, table->ID);
3412
    if (BeginPopupEx(context_menu_id, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoSavedSettings))
3413
        return true;
3414
    table->IsContextPopupOpen = false;
3415
    return false;
3416
}
3417
3418
// Output context menu into current window (generally a popup)
3419
// FIXME-TABLE: Ideally this should be writable by the user. Full programmatic access to that data?
3420
// Sections to display are pulled from 'flags_for_section_to_display', which is typically == table->Flags.
3421
// - ImGuiTableFlags_Resizable   -> display Sizing menu items
3422
// - ImGuiTableFlags_Reorderable -> display "Reset Order"
3423
////- ImGuiTableFlags_Sortable   -> display sorting options (disabled)
3424
// - ImGuiTableFlags_Hideable    -> display columns visibility menu items
3425
// It means if you have a custom context menus you can call this section and omit some sections, and add your own.
3426
void ImGui::TableDrawDefaultContextMenu(ImGuiTable* table, ImGuiTableFlags flags_for_section_to_display)
3427
{
3428
    ImGuiContext& g = *GImGui;
3429
    ImGuiWindow* window = g.CurrentWindow;
3430
    if (window->SkipItems)
3431
        return;
3432
3433
    bool want_separator = false;
3434
    const int column_n = (table->ContextPopupColumn >= 0 && table->ContextPopupColumn < table->ColumnsCount) ? table->ContextPopupColumn : -1;
3435
    ImGuiTableColumn* column = (column_n != -1) ? &table->Columns[column_n] : NULL;
3436
3437
    // Sizing
3438
    if (flags_for_section_to_display & ImGuiTableFlags_Resizable)
3439
    {
3440
        if (column != NULL)
3441
        {
3442
            const bool can_resize = !(column->Flags & ImGuiTableColumnFlags_NoResize) && column->IsEnabled;
3443
            if (MenuItem(LocalizeGetMsg(ImGuiLocKey_TableSizeOne), NULL, false, can_resize)) // "###SizeOne"
3444
                TableSetColumnWidthAutoSingle(table, column_n);
3445
        }
3446
3447
        const char* size_all_desc;
3448
        if (table->ColumnsEnabledFixedCount == table->ColumnsEnabledCount && (table->Flags & ImGuiTableFlags_SizingMask_) != ImGuiTableFlags_SizingFixedSame)
3449
            size_all_desc = LocalizeGetMsg(ImGuiLocKey_TableSizeAllFit);        // "###SizeAll" All fixed
3450
        else
3451
            size_all_desc = LocalizeGetMsg(ImGuiLocKey_TableSizeAllDefault);    // "###SizeAll" All stretch or mixed
3452
        if (MenuItem(size_all_desc, NULL))
3453
            TableSetColumnWidthAutoAll(table);
3454
        want_separator = true;
3455
    }
3456
3457
    // Ordering
3458
    if (flags_for_section_to_display & ImGuiTableFlags_Reorderable)
3459
    {
3460
        if (MenuItem(LocalizeGetMsg(ImGuiLocKey_TableResetOrder), NULL, false, !table->IsDefaultDisplayOrder))
3461
            table->IsResetDisplayOrderRequest = true;
3462
        want_separator = true;
3463
    }
3464
3465
    // Reset all (should work but seems unnecessary/noisy to expose?)
3466
    //if (MenuItem("Reset all"))
3467
    //    table->IsResetAllRequest = true;
3468
3469
    // Sorting
3470
    // (modify TableOpenContextMenu() to add _Sortable flag if enabling this)
3471
#if 0
3472
    if ((flags_for_section_to_display & ImGuiTableFlags_Sortable) && column != NULL && (column->Flags & ImGuiTableColumnFlags_NoSort) == 0)
3473
    {
3474
        if (want_separator)
3475
            Separator();
3476
        want_separator = true;
3477
3478
        bool append_to_sort_specs = g.IO.KeyShift;
3479
        if (MenuItem("Sort in Ascending Order", NULL, column->SortOrder != -1 && column->SortDirection == ImGuiSortDirection_Ascending, (column->Flags & ImGuiTableColumnFlags_NoSortAscending) == 0))
3480
            TableSetColumnSortDirection(table, column_n, ImGuiSortDirection_Ascending, append_to_sort_specs);
3481
        if (MenuItem("Sort in Descending Order", NULL, column->SortOrder != -1 && column->SortDirection == ImGuiSortDirection_Descending, (column->Flags & ImGuiTableColumnFlags_NoSortDescending) == 0))
3482
            TableSetColumnSortDirection(table, column_n, ImGuiSortDirection_Descending, append_to_sort_specs);
3483
    }
3484
#endif
3485
3486
    // Hiding / Visibility
3487
    if (flags_for_section_to_display & ImGuiTableFlags_Hideable)
3488
    {
3489
        if (want_separator)
3490
            Separator();
3491
        want_separator = true;
3492
3493
        PushItemFlag(ImGuiItemFlags_AutoClosePopups, false);
3494
        for (int other_column_n = 0; other_column_n < table->ColumnsCount; other_column_n++)
3495
        {
3496
            ImGuiTableColumn* other_column = &table->Columns[other_column_n];
3497
            if (other_column->Flags & ImGuiTableColumnFlags_Disabled)
3498
                continue;
3499
3500
            const char* name = TableGetColumnName(table, other_column_n);
3501
            if (name == NULL || name[0] == 0)
3502
                name = "<Unknown>";
3503
3504
            // Make sure we can't hide the last active column
3505
            bool menu_item_active = (other_column->Flags & ImGuiTableColumnFlags_NoHide) ? false : true;
3506
            if (other_column->IsUserEnabled && table->ColumnsEnabledCount <= 1)
3507
                menu_item_active = false;
3508
            if (MenuItem(name, NULL, other_column->IsUserEnabled, menu_item_active))
3509
                other_column->IsUserEnabledNextFrame = !other_column->IsUserEnabled;
3510
        }
3511
        PopItemFlag();
3512
    }
3513
}
3514
3515
//-------------------------------------------------------------------------
3516
// [SECTION] Tables: Settings (.ini data)
3517
//-------------------------------------------------------------------------
3518
// FIXME: The binding/finding/creating flow are too confusing.
3519
//-------------------------------------------------------------------------
3520
// - TableSettingsInit() [Internal]
3521
// - TableSettingsCalcChunkSize() [Internal]
3522
// - TableSettingsCreate() [Internal]
3523
// - TableSettingsFindByID() [Internal]
3524
// - TableGetBoundSettings() [Internal]
3525
// - TableResetSettings()
3526
// - TableSaveSettings() [Internal]
3527
// - TableLoadSettings() [Internal]
3528
// - TableSettingsHandler_ClearAll() [Internal]
3529
// - TableSettingsHandler_ApplyAll() [Internal]
3530
// - TableSettingsHandler_ReadOpen() [Internal]
3531
// - TableSettingsHandler_ReadLine() [Internal]
3532
// - TableSettingsHandler_WriteAll() [Internal]
3533
// - TableSettingsInstallHandler() [Internal]
3534
//-------------------------------------------------------------------------
3535
// [Init] 1: TableSettingsHandler_ReadXXXX()   Load and parse .ini file into TableSettings.
3536
// [Main] 2: TableLoadSettings()               When table is created, bind Table to TableSettings, serialize TableSettings data into Table.
3537
// [Main] 3: TableSaveSettings()               When table properties are modified, serialize Table data into bound or new TableSettings, mark .ini as dirty.
3538
// [Main] 4: TableSettingsHandler_WriteAll()   When .ini file is dirty (which can come from other source), save TableSettings into .ini file.
3539
//-------------------------------------------------------------------------
3540
3541
// Clear and initialize empty settings instance
3542
static void TableSettingsInit(ImGuiTableSettings* settings, ImGuiID id, int columns_count, int columns_count_max)
3543
{
3544
    IM_PLACEMENT_NEW(settings) ImGuiTableSettings();
3545
    ImGuiTableColumnSettings* settings_column = settings->GetColumnSettings();
3546
    for (int n = 0; n < columns_count_max; n++, settings_column++)
3547
        IM_PLACEMENT_NEW(settings_column) ImGuiTableColumnSettings();
3548
    settings->ID = id;
3549
    settings->ColumnsCount = (ImGuiTableColumnIdx)columns_count;
3550
    settings->ColumnsCountMax = (ImGuiTableColumnIdx)columns_count_max;
3551
    settings->WantApply = true;
3552
}
3553
3554
static size_t TableSettingsCalcChunkSize(int columns_count)
3555
{
3556
    return sizeof(ImGuiTableSettings) + (size_t)columns_count * sizeof(ImGuiTableColumnSettings);
3557
}
3558
3559
ImGuiTableSettings* ImGui::TableSettingsCreate(ImGuiID id, int columns_count)
3560
{
3561
    ImGuiContext& g = *GImGui;
3562
    ImGuiTableSettings* settings = g.SettingsTables.alloc_chunk(TableSettingsCalcChunkSize(columns_count));
3563
    TableSettingsInit(settings, id, columns_count, columns_count);
3564
    return settings;
3565
}
3566
3567
// Find existing settings
3568
ImGuiTableSettings* ImGui::TableSettingsFindByID(ImGuiID id)
3569
{
3570
    // FIXME-OPT: Might want to store a lookup map for this?
3571
    ImGuiContext& g = *GImGui;
3572
    for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3573
        if (settings->ID == id)
3574
            return settings;
3575
    return NULL;
3576
}
3577
3578
// Get settings for a given table, NULL if none
3579
ImGuiTableSettings* ImGui::TableGetBoundSettings(ImGuiTable* table)
3580
{
3581
    if (table->SettingsOffset != -1)
3582
    {
3583
        ImGuiContext& g = *GImGui;
3584
        ImGuiTableSettings* settings = g.SettingsTables.ptr_from_offset(table->SettingsOffset);
3585
        IM_ASSERT(settings->ID == table->ID);
3586
        if (settings->ColumnsCountMax >= table->ColumnsCount)
3587
            return settings; // OK
3588
        settings->ID = 0; // Invalidate storage, we won't fit because of a count change
3589
    }
3590
    return NULL;
3591
}
3592
3593
// Restore initial state of table (with or without saved settings)
3594
void ImGui::TableResetSettings(ImGuiTable* table)
3595
{
3596
    table->IsInitializing = table->IsSettingsDirty = true;
3597
    table->IsResetAllRequest = false;
3598
    table->IsSettingsRequestLoad = false;                   // Don't reload from ini
3599
    table->SettingsLoadedFlags = ImGuiTableFlags_None;      // Mark as nothing loaded so our initialized data becomes authoritative
3600
}
3601
3602
void ImGui::TableSaveSettings(ImGuiTable* table)
3603
{
3604
    table->IsSettingsDirty = false;
3605
    if (table->Flags & ImGuiTableFlags_NoSavedSettings)
3606
        return;
3607
3608
    // Bind or create settings data
3609
    ImGuiContext& g = *GImGui;
3610
    ImGuiTableSettings* settings = TableGetBoundSettings(table);
3611
    if (settings == NULL)
3612
    {
3613
        settings = TableSettingsCreate(table->ID, table->ColumnsCount);
3614
        table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings);
3615
    }
3616
    settings->ColumnsCount = (ImGuiTableColumnIdx)table->ColumnsCount;
3617
3618
    // Serialize ImGuiTable/ImGuiTableColumn into ImGuiTableSettings/ImGuiTableColumnSettings
3619
    IM_ASSERT(settings->ID == table->ID);
3620
    IM_ASSERT(settings->ColumnsCount == table->ColumnsCount && settings->ColumnsCountMax >= settings->ColumnsCount);
3621
    ImGuiTableColumn* column = table->Columns.Data;
3622
    ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings();
3623
3624
    bool save_ref_scale = false;
3625
    settings->SaveFlags = ImGuiTableFlags_None;
3626
    for (int n = 0; n < table->ColumnsCount; n++, column++, column_settings++)
3627
    {
3628
        const float width_or_weight = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? column->StretchWeight : column->WidthRequest;
3629
        column_settings->WidthOrWeight = width_or_weight;
3630
        column_settings->Index = (ImGuiTableColumnIdx)n;
3631
        column_settings->DisplayOrder = column->DisplayOrder;
3632
        column_settings->SortOrder = column->SortOrder;
3633
        column_settings->SortDirection = column->SortDirection;
3634
        column_settings->IsEnabled = column->IsUserEnabled;
3635
        column_settings->IsStretch = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? 1 : 0;
3636
        if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) == 0)
3637
            save_ref_scale = true;
3638
3639
        // We skip saving some data in the .ini file when they are unnecessary to restore our state.
3640
        // Note that fixed width where initial width was derived from auto-fit will always be saved as InitStretchWeightOrWidth will be 0.0f.
3641
        // FIXME-TABLE: We don't have logic to easily compare SortOrder to DefaultSortOrder yet so it's always saved when present.
3642
        if (width_or_weight != column->InitStretchWeightOrWidth)
3643
            settings->SaveFlags |= ImGuiTableFlags_Resizable;
3644
        if (column->DisplayOrder != n)
3645
            settings->SaveFlags |= ImGuiTableFlags_Reorderable;
3646
        if (column->SortOrder != -1)
3647
            settings->SaveFlags |= ImGuiTableFlags_Sortable;
3648
        if (column->IsUserEnabled != ((column->Flags & ImGuiTableColumnFlags_DefaultHide) == 0))
3649
            settings->SaveFlags |= ImGuiTableFlags_Hideable;
3650
    }
3651
    settings->SaveFlags &= table->Flags;
3652
    settings->RefScale = save_ref_scale ? table->RefScale : 0.0f;
3653
3654
    MarkIniSettingsDirty();
3655
}
3656
3657
void ImGui::TableLoadSettings(ImGuiTable* table)
3658
{
3659
    ImGuiContext& g = *GImGui;
3660
    table->IsSettingsRequestLoad = false;
3661
    if (table->Flags & ImGuiTableFlags_NoSavedSettings)
3662
        return;
3663
3664
    // Bind settings
3665
    ImGuiTableSettings* settings;
3666
    if (table->SettingsOffset == -1)
3667
    {
3668
        settings = TableSettingsFindByID(table->ID);
3669
        if (settings == NULL)
3670
            return;
3671
        if (settings->ColumnsCount != table->ColumnsCount) // Allow settings if columns count changed. We could otherwise decide to return...
3672
            table->IsSettingsDirty = true;
3673
        table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings);
3674
    }
3675
    else
3676
    {
3677
        settings = TableGetBoundSettings(table);
3678
    }
3679
3680
    table->SettingsLoadedFlags = settings->SaveFlags;
3681
    table->RefScale = settings->RefScale;
3682
3683
    // Serialize ImGuiTableSettings/ImGuiTableColumnSettings into ImGuiTable/ImGuiTableColumn
3684
    ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings();
3685
    ImU64 display_order_mask = 0;
3686
    for (int data_n = 0; data_n < settings->ColumnsCount; data_n++, column_settings++)
3687
    {
3688
        int column_n = column_settings->Index;
3689
        if (column_n < 0 || column_n >= table->ColumnsCount)
3690
            continue;
3691
3692
        ImGuiTableColumn* column = &table->Columns[column_n];
3693
        if (settings->SaveFlags & ImGuiTableFlags_Resizable)
3694
        {
3695
            if (column_settings->IsStretch)
3696
                column->StretchWeight = column_settings->WidthOrWeight;
3697
            else
3698
                column->WidthRequest = column_settings->WidthOrWeight;
3699
            column->AutoFitQueue = 0x00;
3700
        }
3701
        if (settings->SaveFlags & ImGuiTableFlags_Reorderable)
3702
            column->DisplayOrder = column_settings->DisplayOrder;
3703
        else
3704
            column->DisplayOrder = (ImGuiTableColumnIdx)column_n;
3705
        display_order_mask |= (ImU64)1 << column->DisplayOrder;
3706
        column->IsUserEnabled = column->IsUserEnabledNextFrame = column_settings->IsEnabled;
3707
        column->SortOrder = column_settings->SortOrder;
3708
        column->SortDirection = column_settings->SortDirection;
3709
    }
3710
3711
    // Validate and fix invalid display order data
3712
    const ImU64 expected_display_order_mask = (settings->ColumnsCount == 64) ? ~0 : ((ImU64)1 << settings->ColumnsCount) - 1;
3713
    if (display_order_mask != expected_display_order_mask)
3714
        for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3715
            table->Columns[column_n].DisplayOrder = (ImGuiTableColumnIdx)column_n;
3716
3717
    // Rebuild index
3718
    for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
3719
        table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n;
3720
}
3721
3722
static void TableSettingsHandler_ClearAll(ImGuiContext* ctx, ImGuiSettingsHandler*)
3723
{
3724
    ImGuiContext& g = *ctx;
3725
    for (int i = 0; i != g.Tables.GetMapSize(); i++)
3726
        if (ImGuiTable* table = g.Tables.TryGetMapData(i))
3727
            table->SettingsOffset = -1;
3728
    g.SettingsTables.clear();
3729
}
3730
3731
// Apply to existing windows (if any)
3732
static void TableSettingsHandler_ApplyAll(ImGuiContext* ctx, ImGuiSettingsHandler*)
3733
{
3734
    ImGuiContext& g = *ctx;
3735
    for (int i = 0; i != g.Tables.GetMapSize(); i++)
3736
        if (ImGuiTable* table = g.Tables.TryGetMapData(i))
3737
        {
3738
            table->IsSettingsRequestLoad = true;
3739
            table->SettingsOffset = -1;
3740
        }
3741
}
3742
3743
static void* TableSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name)
3744
{
3745
    ImGuiID id = 0;
3746
    int columns_count = 0;
3747
    if (sscanf(name, "0x%08X,%d", &id, &columns_count) < 2)
3748
        return NULL;
3749
3750
    if (ImGuiTableSettings* settings = ImGui::TableSettingsFindByID(id))
3751
    {
3752
        if (settings->ColumnsCountMax >= columns_count)
3753
        {
3754
            TableSettingsInit(settings, id, columns_count, settings->ColumnsCountMax); // Recycle
3755
            return settings;
3756
        }
3757
        settings->ID = 0; // Invalidate storage, we won't fit because of a count change
3758
    }
3759
    return ImGui::TableSettingsCreate(id, columns_count);
3760
}
3761
3762
static void TableSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line)
3763
{
3764
    // "Column 0  UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v"
3765
    ImGuiTableSettings* settings = (ImGuiTableSettings*)entry;
3766
    float f = 0.0f;
3767
    int column_n = 0, r = 0, n = 0;
3768
3769
    if (sscanf(line, "RefScale=%f", &f) == 1) { settings->RefScale = f; return; }
3770
3771
    if (sscanf(line, "Column %d%n", &column_n, &r) == 1)
3772
    {
3773
        if (column_n < 0 || column_n >= settings->ColumnsCount)
3774
            return;
3775
        line = ImStrSkipBlank(line + r);
3776
        char c = 0;
3777
        ImGuiTableColumnSettings* column = settings->GetColumnSettings() + column_n;
3778
        column->Index = (ImGuiTableColumnIdx)column_n;
3779
        if (sscanf(line, "UserID=0x%08X%n", (ImU32*)&n, &r)==1) { line = ImStrSkipBlank(line + r); column->UserID = (ImGuiID)n; }
3780
        if (sscanf(line, "Width=%d%n", &n, &r) == 1)            { line = ImStrSkipBlank(line + r); column->WidthOrWeight = (float)n; column->IsStretch = 0; settings->SaveFlags |= ImGuiTableFlags_Resizable; }
3781
        if (sscanf(line, "Weight=%f%n", &f, &r) == 1)           { line = ImStrSkipBlank(line + r); column->WidthOrWeight = f; column->IsStretch = 1; settings->SaveFlags |= ImGuiTableFlags_Resizable; }
3782
        if (sscanf(line, "Visible=%d%n", &n, &r) == 1)          { line = ImStrSkipBlank(line + r); column->IsEnabled = (ImU8)n; settings->SaveFlags |= ImGuiTableFlags_Hideable; }
3783
        if (sscanf(line, "Order=%d%n", &n, &r) == 1)            { line = ImStrSkipBlank(line + r); column->DisplayOrder = (ImGuiTableColumnIdx)n; settings->SaveFlags |= ImGuiTableFlags_Reorderable; }
3784
        if (sscanf(line, "Sort=%d%c%n", &n, &c, &r) == 2)       { line = ImStrSkipBlank(line + r); column->SortOrder = (ImGuiTableColumnIdx)n; column->SortDirection = (c == '^') ? ImGuiSortDirection_Descending : ImGuiSortDirection_Ascending; settings->SaveFlags |= ImGuiTableFlags_Sortable; }
3785
    }
3786
}
3787
3788
static void TableSettingsHandler_WriteAll(ImGuiContext* ctx, ImGuiSettingsHandler* handler, ImGuiTextBuffer* buf)
3789
{
3790
    ImGuiContext& g = *ctx;
3791
    for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3792
    {
3793
        if (settings->ID == 0) // Skip ditched settings
3794
            continue;
3795
3796
        // TableSaveSettings() may clear some of those flags when we establish that the data can be stripped
3797
        // (e.g. Order was unchanged)
3798
        const bool save_size    = (settings->SaveFlags & ImGuiTableFlags_Resizable) != 0;
3799
        const bool save_visible = (settings->SaveFlags & ImGuiTableFlags_Hideable) != 0;
3800
        const bool save_order   = (settings->SaveFlags & ImGuiTableFlags_Reorderable) != 0;
3801
        const bool save_sort    = (settings->SaveFlags & ImGuiTableFlags_Sortable) != 0;
3802
        if (!save_size && !save_visible && !save_order && !save_sort)
3803
            continue;
3804
3805
        buf->reserve(buf->size() + 30 + settings->ColumnsCount * 50); // ballpark reserve
3806
        buf->appendf("[%s][0x%08X,%d]\n", handler->TypeName, settings->ID, settings->ColumnsCount);
3807
        if (settings->RefScale != 0.0f)
3808
            buf->appendf("RefScale=%g\n", settings->RefScale);
3809
        ImGuiTableColumnSettings* column = settings->GetColumnSettings();
3810
        for (int column_n = 0; column_n < settings->ColumnsCount; column_n++, column++)
3811
        {
3812
            // "Column 0  UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v"
3813
            bool save_column = column->UserID != 0 || save_size || save_visible || save_order || (save_sort && column->SortOrder != -1);
3814
            if (!save_column)
3815
                continue;
3816
            buf->appendf("Column %-2d", column_n);
3817
            if (column->UserID != 0)                    { buf->appendf(" UserID=%08X", column->UserID); }
3818
            if (save_size && column->IsStretch)         { buf->appendf(" Weight=%.4f", column->WidthOrWeight); }
3819
            if (save_size && !column->IsStretch)        { buf->appendf(" Width=%d", (int)column->WidthOrWeight); }
3820
            if (save_visible)                           { buf->appendf(" Visible=%d", column->IsEnabled); }
3821
            if (save_order)                             { buf->appendf(" Order=%d", column->DisplayOrder); }
3822
            if (save_sort && column->SortOrder != -1)   { buf->appendf(" Sort=%d%c", column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? 'v' : '^'); }
3823
            buf->append("\n");
3824
        }
3825
        buf->append("\n");
3826
    }
3827
}
3828
3829
void ImGui::TableSettingsAddSettingsHandler()
3830
{
3831
    ImGuiSettingsHandler ini_handler;
3832
    ini_handler.TypeName = "Table";
3833
    ini_handler.TypeHash = ImHashStr("Table");
3834
    ini_handler.ClearAllFn = TableSettingsHandler_ClearAll;
3835
    ini_handler.ReadOpenFn = TableSettingsHandler_ReadOpen;
3836
    ini_handler.ReadLineFn = TableSettingsHandler_ReadLine;
3837
    ini_handler.ApplyAllFn = TableSettingsHandler_ApplyAll;
3838
    ini_handler.WriteAllFn = TableSettingsHandler_WriteAll;
3839
    AddSettingsHandler(&ini_handler);
3840
}
3841
3842
//-------------------------------------------------------------------------
3843
// [SECTION] Tables: Garbage Collection
3844
//-------------------------------------------------------------------------
3845
// - TableRemove() [Internal]
3846
// - TableGcCompactTransientBuffers() [Internal]
3847
// - TableGcCompactSettings() [Internal]
3848
//-------------------------------------------------------------------------
3849
3850
// Remove Table (currently only used by TestEngine)
3851
void ImGui::TableRemove(ImGuiTable* table)
3852
{
3853
    //IMGUI_DEBUG_PRINT("TableRemove() id=0x%08X\n", table->ID);
3854
    ImGuiContext& g = *GImGui;
3855
    int table_idx = g.Tables.GetIndex(table);
3856
    //memset(table->RawData.Data, 0, table->RawData.size_in_bytes());
3857
    //memset(table, 0, sizeof(ImGuiTable));
3858
    g.Tables.Remove(table->ID, table);
3859
    g.TablesLastTimeActive[table_idx] = -1.0f;
3860
}
3861
3862
// Free up/compact internal Table buffers for when it gets unused
3863
void ImGui::TableGcCompactTransientBuffers(ImGuiTable* table)
3864
{
3865
    //IMGUI_DEBUG_PRINT("TableGcCompactTransientBuffers() id=0x%08X\n", table->ID);
3866
    ImGuiContext& g = *GImGui;
3867
    IM_ASSERT(table->MemoryCompacted == false);
3868
    table->SortSpecs.Specs = NULL;
3869
    table->SortSpecsMulti.clear();
3870
    table->IsSortSpecsDirty = true; // FIXME: In theory shouldn't have to leak into user performing a sort on resume.
3871
    table->ColumnsNames.clear();
3872
    table->MemoryCompacted = true;
3873
    for (int n = 0; n < table->ColumnsCount; n++)
3874
        table->Columns[n].NameOffset = -1;
3875
    g.TablesLastTimeActive[g.Tables.GetIndex(table)] = -1.0f;
3876
}
3877
3878
void ImGui::TableGcCompactTransientBuffers(ImGuiTableTempData* temp_data)
3879
{
3880
    temp_data->DrawSplitter.ClearFreeMemory();
3881
    temp_data->LastTimeActive = -1.0f;
3882
}
3883
3884
// Compact and remove unused settings data (currently only used by TestEngine)
3885
void ImGui::TableGcCompactSettings()
3886
{
3887
    ImGuiContext& g = *GImGui;
3888
    int required_memory = 0;
3889
    for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3890
        if (settings->ID != 0)
3891
            required_memory += (int)TableSettingsCalcChunkSize(settings->ColumnsCount);
3892
    if (required_memory == g.SettingsTables.Buf.Size)
3893
        return;
3894
    ImChunkStream<ImGuiTableSettings> new_chunk_stream;
3895
    new_chunk_stream.Buf.reserve(required_memory);
3896
    for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
3897
        if (settings->ID != 0)
3898
            memcpy(new_chunk_stream.alloc_chunk(TableSettingsCalcChunkSize(settings->ColumnsCount)), settings, TableSettingsCalcChunkSize(settings->ColumnsCount));
3899
    g.SettingsTables.swap(new_chunk_stream);
3900
}
3901
3902
3903
//-------------------------------------------------------------------------
3904
// [SECTION] Tables: Debugging
3905
//-------------------------------------------------------------------------
3906
// - DebugNodeTable() [Internal]
3907
//-------------------------------------------------------------------------
3908
3909
#ifndef IMGUI_DISABLE_DEBUG_TOOLS
3910
3911
static const char* DebugNodeTableGetSizingPolicyDesc(ImGuiTableFlags sizing_policy)
3912
{
3913
    sizing_policy &= ImGuiTableFlags_SizingMask_;
3914
    if (sizing_policy == ImGuiTableFlags_SizingFixedFit)    { return "FixedFit"; }
3915
    if (sizing_policy == ImGuiTableFlags_SizingFixedSame)   { return "FixedSame"; }
3916
    if (sizing_policy == ImGuiTableFlags_SizingStretchProp) { return "StretchProp"; }
3917
    if (sizing_policy == ImGuiTableFlags_SizingStretchSame) { return "StretchSame"; }
3918
    return "N/A";
3919
}
3920
3921
void ImGui::DebugNodeTable(ImGuiTable* table)
3922
{
3923
    ImGuiContext& g = *GImGui;
3924
    const bool is_active = (table->LastFrameActive >= g.FrameCount - 2); // Note that fully clipped early out scrolling tables will appear as inactive here.
3925
    if (!is_active) { PushStyleColor(ImGuiCol_Text, GetStyleColorVec4(ImGuiCol_TextDisabled)); }
3926
    bool open = TreeNode(table, "Table 0x%08X (%d columns, in '%s')%s", table->ID, table->ColumnsCount, table->OuterWindow->Name, is_active ? "" : " *Inactive*");
3927
    if (!is_active) { PopStyleColor(); }
3928
    if (IsItemHovered())
3929
        GetForegroundDrawList()->AddRect(table->OuterRect.Min, table->OuterRect.Max, IM_COL32(255, 255, 0, 255));
3930
    if (IsItemVisible() && table->HoveredColumnBody != -1)
3931
        GetForegroundDrawList()->AddRect(GetItemRectMin(), GetItemRectMax(), IM_COL32(255, 255, 0, 255));
3932
    if (!open)
3933
        return;
3934
    if (table->InstanceCurrent > 0)
3935
        Text("** %d instances of same table! Some data below will refer to last instance.", table->InstanceCurrent + 1);
3936
    if (g.IO.ConfigDebugIsDebuggerPresent)
3937
    {
3938
        if (DebugBreakButton("**DebugBreak**", "in BeginTable()"))
3939
            g.DebugBreakInTable = table->ID;
3940
        SameLine();
3941
    }
3942
3943
    bool clear_settings = SmallButton("Clear settings");
3944
    BulletText("OuterRect: Pos: (%.1f,%.1f) Size: (%.1f,%.1f) Sizing: '%s'", table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.GetWidth(), table->OuterRect.GetHeight(), DebugNodeTableGetSizingPolicyDesc(table->Flags));
3945
    BulletText("ColumnsGivenWidth: %.1f, ColumnsAutoFitWidth: %.1f, InnerWidth: %.1f%s", table->ColumnsGivenWidth, table->ColumnsAutoFitWidth, table->InnerWidth, table->InnerWidth == 0.0f ? " (auto)" : "");
3946
    BulletText("CellPaddingX: %.1f, CellSpacingX: %.1f/%.1f, OuterPaddingX: %.1f", table->CellPaddingX, table->CellSpacingX1, table->CellSpacingX2, table->OuterPaddingX);
3947
    BulletText("HoveredColumnBody: %d, HoveredColumnBorder: %d", table->HoveredColumnBody, table->HoveredColumnBorder);
3948
    BulletText("ResizedColumn: %d, ReorderColumn: %d, HeldHeaderColumn: %d", table->ResizedColumn, table->ReorderColumn, table->HeldHeaderColumn);
3949
    for (int n = 0; n < table->InstanceCurrent + 1; n++)
3950
    {
3951
        ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, n);
3952
        BulletText("Instance %d: HoveredRow: %d, LastOuterHeight: %.2f", n, table_instance->HoveredRowLast, table_instance->LastOuterHeight);
3953
    }
3954
    //BulletText("BgDrawChannels: %d/%d", 0, table->BgDrawChannelUnfrozen);
3955
    float sum_weights = 0.0f;
3956
    for (int n = 0; n < table->ColumnsCount; n++)
3957
        if (table->Columns[n].Flags & ImGuiTableColumnFlags_WidthStretch)
3958
            sum_weights += table->Columns[n].StretchWeight;
3959
    for (int n = 0; n < table->ColumnsCount; n++)
3960
    {
3961
        ImGuiTableColumn* column = &table->Columns[n];
3962
        const char* name = TableGetColumnName(table, n);
3963
        char buf[512];
3964
        ImFormatString(buf, IM_ARRAYSIZE(buf),
3965
            "Column %d order %d '%s': offset %+.2f to %+.2f%s\n"
3966
            "Enabled: %d, VisibleX/Y: %d/%d, RequestOutput: %d, SkipItems: %d, DrawChannels: %d,%d\n"
3967
            "WidthGiven: %.1f, Request/Auto: %.1f/%.1f, StretchWeight: %.3f (%.1f%%)\n"
3968
            "MinX: %.1f, MaxX: %.1f (%+.1f), ClipRect: %.1f to %.1f (+%.1f)\n"
3969
            "ContentWidth: %.1f,%.1f, HeadersUsed/Ideal %.1f/%.1f\n"
3970
            "Sort: %d%s, UserID: 0x%08X, Flags: 0x%04X: %s%s%s..",
3971
            n, column->DisplayOrder, name, column->MinX - table->WorkRect.Min.x, column->MaxX - table->WorkRect.Min.x, (n < table->FreezeColumnsRequest) ? " (Frozen)" : "",
3972
            column->IsEnabled, column->IsVisibleX, column->IsVisibleY, column->IsRequestOutput, column->IsSkipItems, column->DrawChannelFrozen, column->DrawChannelUnfrozen,
3973
            column->WidthGiven, column->WidthRequest, column->WidthAuto, column->StretchWeight, column->StretchWeight > 0.0f ? (column->StretchWeight / sum_weights) * 100.0f : 0.0f,
3974
            column->MinX, column->MaxX, column->MaxX - column->MinX, column->ClipRect.Min.x, column->ClipRect.Max.x, column->ClipRect.Max.x - column->ClipRect.Min.x,
3975
            column->ContentMaxXFrozen - column->WorkMinX, column->ContentMaxXUnfrozen - column->WorkMinX, column->ContentMaxXHeadersUsed - column->WorkMinX, column->ContentMaxXHeadersIdeal - column->WorkMinX,
3976
            column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? " (Asc)" : (column->SortDirection == ImGuiSortDirection_Descending) ? " (Des)" : "", column->UserID, column->Flags,
3977
            (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? "WidthStretch " : "",
3978
            (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? "WidthFixed " : "",
3979
            (column->Flags & ImGuiTableColumnFlags_NoResize) ? "NoResize " : "");
3980
        Bullet();
3981
        Selectable(buf);
3982
        if (IsItemHovered())
3983
        {
3984
            ImRect r(column->MinX, table->OuterRect.Min.y, column->MaxX, table->OuterRect.Max.y);
3985
            GetForegroundDrawList()->AddRect(r.Min, r.Max, IM_COL32(255, 255, 0, 255));
3986
        }
3987
    }
3988
    if (ImGuiTableSettings* settings = TableGetBoundSettings(table))
3989
        DebugNodeTableSettings(settings);
3990
    if (clear_settings)
3991
        table->IsResetAllRequest = true;
3992
    TreePop();
3993
}
3994
3995
void ImGui::DebugNodeTableSettings(ImGuiTableSettings* settings)
3996
{
3997
    if (!TreeNode((void*)(intptr_t)settings->ID, "Settings 0x%08X (%d columns)", settings->ID, settings->ColumnsCount))
3998
        return;
3999
    BulletText("SaveFlags: 0x%08X", settings->SaveFlags);
4000
    BulletText("ColumnsCount: %d (max %d)", settings->ColumnsCount, settings->ColumnsCountMax);
4001
    for (int n = 0; n < settings->ColumnsCount; n++)
4002
    {
4003
        ImGuiTableColumnSettings* column_settings = &settings->GetColumnSettings()[n];
4004
        ImGuiSortDirection sort_dir = (column_settings->SortOrder != -1) ? (ImGuiSortDirection)column_settings->SortDirection : ImGuiSortDirection_None;
4005
        BulletText("Column %d Order %d SortOrder %d %s Vis %d %s %7.3f UserID 0x%08X",
4006
            n, column_settings->DisplayOrder, column_settings->SortOrder,
4007
            (sort_dir == ImGuiSortDirection_Ascending) ? "Asc" : (sort_dir == ImGuiSortDirection_Descending) ? "Des" : "---",
4008
            column_settings->IsEnabled, column_settings->IsStretch ? "Weight" : "Width ", column_settings->WidthOrWeight, column_settings->UserID);
4009
    }
4010
    TreePop();
4011
}
4012
4013
#else // #ifndef IMGUI_DISABLE_DEBUG_TOOLS
4014
4015
void ImGui::DebugNodeTable(ImGuiTable*) {}
4016
void ImGui::DebugNodeTableSettings(ImGuiTableSettings*) {}
4017
4018
#endif
4019
4020
4021
//-------------------------------------------------------------------------
4022
// [SECTION] Columns, BeginColumns, EndColumns, etc.
4023
// (This is a legacy API, prefer using BeginTable/EndTable!)
4024
//-------------------------------------------------------------------------
4025
// FIXME: sizing is lossy when columns width is very small (default width may turn negative etc.)
4026
//-------------------------------------------------------------------------
4027
// - SetWindowClipRectBeforeSetChannel() [Internal]
4028
// - GetColumnIndex()
4029
// - GetColumnsCount()
4030
// - GetColumnOffset()
4031
// - GetColumnWidth()
4032
// - SetColumnOffset()
4033
// - SetColumnWidth()
4034
// - PushColumnClipRect() [Internal]
4035
// - PushColumnsBackground() [Internal]
4036
// - PopColumnsBackground() [Internal]
4037
// - FindOrCreateColumns() [Internal]
4038
// - GetColumnsID() [Internal]
4039
// - BeginColumns()
4040
// - NextColumn()
4041
// - EndColumns()
4042
// - Columns()
4043
//-------------------------------------------------------------------------
4044
4045
// [Internal] Small optimization to avoid calls to PopClipRect/SetCurrentChannel/PushClipRect in sequences,
4046
// they would meddle many times with the underlying ImDrawCmd.
4047
// Instead, we do a preemptive overwrite of clipping rectangle _without_ altering the command-buffer and let
4048
// the subsequent single call to SetCurrentChannel() does it things once.
4049
void ImGui::SetWindowClipRectBeforeSetChannel(ImGuiWindow* window, const ImRect& clip_rect)
4050
{
4051
    ImVec4 clip_rect_vec4 = clip_rect.ToVec4();
4052
    window->ClipRect = clip_rect;
4053
    window->DrawList->_CmdHeader.ClipRect = clip_rect_vec4;
4054
    window->DrawList->_ClipRectStack.Data[window->DrawList->_ClipRectStack.Size - 1] = clip_rect_vec4;
4055
}
4056
4057
int ImGui::GetColumnIndex()
4058
{
4059
    ImGuiWindow* window = GetCurrentWindowRead();
4060
    return window->DC.CurrentColumns ? window->DC.CurrentColumns->Current : 0;
4061
}
4062
4063
int ImGui::GetColumnsCount()
4064
{
4065
    ImGuiWindow* window = GetCurrentWindowRead();
4066
    return window->DC.CurrentColumns ? window->DC.CurrentColumns->Count : 1;
4067
}
4068
4069
float ImGui::GetColumnOffsetFromNorm(const ImGuiOldColumns* columns, float offset_norm)
4070
{
4071
    return offset_norm * (columns->OffMaxX - columns->OffMinX);
4072
}
4073
4074
float ImGui::GetColumnNormFromOffset(const ImGuiOldColumns* columns, float offset)
4075
{
4076
    return offset / (columns->OffMaxX - columns->OffMinX);
4077
}
4078
4079
static const float COLUMNS_HIT_RECT_HALF_THICKNESS = 4.0f;
4080
4081
static float GetDraggedColumnOffset(ImGuiOldColumns* columns, int column_index)
4082
{
4083
    // Active (dragged) column always follow mouse. The reason we need this is that dragging a column to the right edge of an auto-resizing
4084
    // window creates a feedback loop because we store normalized positions. So while dragging we enforce absolute positioning.
4085
    ImGuiContext& g = *GImGui;
4086
    ImGuiWindow* window = g.CurrentWindow;
4087
    IM_ASSERT(column_index > 0); // We are not supposed to drag column 0.
4088
    IM_ASSERT(g.ActiveId == columns->ID + ImGuiID(column_index));
4089
4090
    float x = g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(COLUMNS_HIT_RECT_HALF_THICKNESS * g.CurrentDpiScale) - window->Pos.x;
4091
    x = ImMax(x, ImGui::GetColumnOffset(column_index - 1) + g.Style.ColumnsMinSpacing);
4092
    if ((columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths))
4093
        x = ImMin(x, ImGui::GetColumnOffset(column_index + 1) - g.Style.ColumnsMinSpacing);
4094
4095
    return x;
4096
}
4097
4098
float ImGui::GetColumnOffset(int column_index)
4099
{
4100
    ImGuiWindow* window = GetCurrentWindowRead();
4101
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4102
    if (columns == NULL)
4103
        return 0.0f;
4104
4105
    if (column_index < 0)
4106
        column_index = columns->Current;
4107
    IM_ASSERT(column_index < columns->Columns.Size);
4108
4109
    const float t = columns->Columns[column_index].OffsetNorm;
4110
    const float x_offset = ImLerp(columns->OffMinX, columns->OffMaxX, t);
4111
    return x_offset;
4112
}
4113
4114
static float GetColumnWidthEx(ImGuiOldColumns* columns, int column_index, bool before_resize = false)
4115
{
4116
    if (column_index < 0)
4117
        column_index = columns->Current;
4118
4119
    float offset_norm;
4120
    if (before_resize)
4121
        offset_norm = columns->Columns[column_index + 1].OffsetNormBeforeResize - columns->Columns[column_index].OffsetNormBeforeResize;
4122
    else
4123
        offset_norm = columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm;
4124
    return ImGui::GetColumnOffsetFromNorm(columns, offset_norm);
4125
}
4126
4127
float ImGui::GetColumnWidth(int column_index)
4128
{
4129
    ImGuiContext& g = *GImGui;
4130
    ImGuiWindow* window = g.CurrentWindow;
4131
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4132
    if (columns == NULL)
4133
        return GetContentRegionAvail().x;
4134
4135
    if (column_index < 0)
4136
        column_index = columns->Current;
4137
    return GetColumnOffsetFromNorm(columns, columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm);
4138
}
4139
4140
void ImGui::SetColumnOffset(int column_index, float offset)
4141
{
4142
    ImGuiContext& g = *GImGui;
4143
    ImGuiWindow* window = g.CurrentWindow;
4144
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4145
    IM_ASSERT(columns != NULL);
4146
4147
    if (column_index < 0)
4148
        column_index = columns->Current;
4149
    IM_ASSERT(column_index < columns->Columns.Size);
4150
4151
    const bool preserve_width = !(columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths) && (column_index < columns->Count - 1);
4152
    const float width = preserve_width ? GetColumnWidthEx(columns, column_index, columns->IsBeingResized) : 0.0f;
4153
4154
    if (!(columns->Flags & ImGuiOldColumnFlags_NoForceWithinWindow))
4155
        offset = ImMin(offset, columns->OffMaxX - g.Style.ColumnsMinSpacing * (columns->Count - column_index));
4156
    columns->Columns[column_index].OffsetNorm = GetColumnNormFromOffset(columns, offset - columns->OffMinX);
4157
4158
    if (preserve_width)
4159
        SetColumnOffset(column_index + 1, offset + ImMax(g.Style.ColumnsMinSpacing, width));
4160
}
4161
4162
void ImGui::SetColumnWidth(int column_index, float width)
4163
{
4164
    ImGuiWindow* window = GetCurrentWindowRead();
4165
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4166
    IM_ASSERT(columns != NULL);
4167
4168
    if (column_index < 0)
4169
        column_index = columns->Current;
4170
    SetColumnOffset(column_index + 1, GetColumnOffset(column_index) + width);
4171
}
4172
4173
void ImGui::PushColumnClipRect(int column_index)
4174
{
4175
    ImGuiWindow* window = GetCurrentWindowRead();
4176
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4177
    if (column_index < 0)
4178
        column_index = columns->Current;
4179
4180
    ImGuiOldColumnData* column = &columns->Columns[column_index];
4181
    PushClipRect(column->ClipRect.Min, column->ClipRect.Max, false);
4182
}
4183
4184
// Get into the columns background draw command (which is generally the same draw command as before we called BeginColumns)
4185
void ImGui::PushColumnsBackground()
4186
{
4187
    ImGuiWindow* window = GetCurrentWindowRead();
4188
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4189
    if (columns->Count == 1)
4190
        return;
4191
4192
    // Optimization: avoid SetCurrentChannel() + PushClipRect()
4193
    columns->HostBackupClipRect = window->ClipRect;
4194
    SetWindowClipRectBeforeSetChannel(window, columns->HostInitialClipRect);
4195
    columns->Splitter.SetCurrentChannel(window->DrawList, 0);
4196
}
4197
4198
void ImGui::PopColumnsBackground()
4199
{
4200
    ImGuiWindow* window = GetCurrentWindowRead();
4201
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4202
    if (columns->Count == 1)
4203
        return;
4204
4205
    // Optimization: avoid PopClipRect() + SetCurrentChannel()
4206
    SetWindowClipRectBeforeSetChannel(window, columns->HostBackupClipRect);
4207
    columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1);
4208
}
4209
4210
ImGuiOldColumns* ImGui::FindOrCreateColumns(ImGuiWindow* window, ImGuiID id)
4211
{
4212
    // We have few columns per window so for now we don't need bother much with turning this into a faster lookup.
4213
    for (int n = 0; n < window->ColumnsStorage.Size; n++)
4214
        if (window->ColumnsStorage[n].ID == id)
4215
            return &window->ColumnsStorage[n];
4216
4217
    window->ColumnsStorage.push_back(ImGuiOldColumns());
4218
    ImGuiOldColumns* columns = &window->ColumnsStorage.back();
4219
    columns->ID = id;
4220
    return columns;
4221
}
4222
4223
ImGuiID ImGui::GetColumnsID(const char* str_id, int columns_count)
4224
{
4225
    ImGuiWindow* window = GetCurrentWindow();
4226
4227
    // Differentiate column ID with an arbitrary prefix for cases where users name their columns set the same as another widget.
4228
    // In addition, when an identifier isn't explicitly provided we include the number of columns in the hash to make it uniquer.
4229
    PushID(0x11223347 + (str_id ? 0 : columns_count));
4230
    ImGuiID id = window->GetID(str_id ? str_id : "columns");
4231
    PopID();
4232
4233
    return id;
4234
}
4235
4236
void ImGui::BeginColumns(const char* str_id, int columns_count, ImGuiOldColumnFlags flags)
4237
{
4238
    ImGuiContext& g = *GImGui;
4239
    ImGuiWindow* window = GetCurrentWindow();
4240
4241
    IM_ASSERT(columns_count >= 1);
4242
    IM_ASSERT(window->DC.CurrentColumns == NULL);   // Nested columns are currently not supported
4243
4244
    // Acquire storage for the columns set
4245
    ImGuiID id = GetColumnsID(str_id, columns_count);
4246
    ImGuiOldColumns* columns = FindOrCreateColumns(window, id);
4247
    IM_ASSERT(columns->ID == id);
4248
    columns->Current = 0;
4249
    columns->Count = columns_count;
4250
    columns->Flags = flags;
4251
    window->DC.CurrentColumns = columns;
4252
    window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX();
4253
4254
    columns->HostCursorPosY = window->DC.CursorPos.y;
4255
    columns->HostCursorMaxPosX = window->DC.CursorMaxPos.x;
4256
    columns->HostInitialClipRect = window->ClipRect;
4257
    columns->HostBackupParentWorkRect = window->ParentWorkRect;
4258
    window->ParentWorkRect = window->WorkRect;
4259
4260
    // Set state for first column
4261
    // We aim so that the right-most column will have the same clipping width as other after being clipped by parent ClipRect
4262
    const float column_padding = g.Style.ItemSpacing.x;
4263
    const float half_clip_extend_x = ImTrunc(ImMax(window->WindowPadding.x * 0.5f, window->WindowBorderSize));
4264
    const float max_1 = window->WorkRect.Max.x + column_padding - ImMax(column_padding - window->WindowPadding.x, 0.0f);
4265
    const float max_2 = window->WorkRect.Max.x + half_clip_extend_x;
4266
    columns->OffMinX = window->DC.Indent.x - column_padding + ImMax(column_padding - window->WindowPadding.x, 0.0f);
4267
    columns->OffMaxX = ImMax(ImMin(max_1, max_2) - window->Pos.x, columns->OffMinX + 1.0f);
4268
    columns->LineMinY = columns->LineMaxY = window->DC.CursorPos.y;
4269
4270
    // Clear data if columns count changed
4271
    if (columns->Columns.Size != 0 && columns->Columns.Size != columns_count + 1)
4272
        columns->Columns.resize(0);
4273
4274
    // Initialize default widths
4275
    columns->IsFirstFrame = (columns->Columns.Size == 0);
4276
    if (columns->Columns.Size == 0)
4277
    {
4278
        columns->Columns.reserve(columns_count + 1);
4279
        for (int n = 0; n < columns_count + 1; n++)
4280
        {
4281
            ImGuiOldColumnData column;
4282
            column.OffsetNorm = n / (float)columns_count;
4283
            columns->Columns.push_back(column);
4284
        }
4285
    }
4286
4287
    for (int n = 0; n < columns_count; n++)
4288
    {
4289
        // Compute clipping rectangle
4290
        ImGuiOldColumnData* column = &columns->Columns[n];
4291
        float clip_x1 = IM_ROUND(window->Pos.x + GetColumnOffset(n));
4292
        float clip_x2 = IM_ROUND(window->Pos.x + GetColumnOffset(n + 1) - 1.0f);
4293
        column->ClipRect = ImRect(clip_x1, -FLT_MAX, clip_x2, +FLT_MAX);
4294
        column->ClipRect.ClipWithFull(window->ClipRect);
4295
    }
4296
4297
    if (columns->Count > 1)
4298
    {
4299
        columns->Splitter.Split(window->DrawList, 1 + columns->Count);
4300
        columns->Splitter.SetCurrentChannel(window->DrawList, 1);
4301
        PushColumnClipRect(0);
4302
    }
4303
4304
    // We don't generally store Indent.x inside ColumnsOffset because it may be manipulated by the user.
4305
    float offset_0 = GetColumnOffset(columns->Current);
4306
    float offset_1 = GetColumnOffset(columns->Current + 1);
4307
    float width = offset_1 - offset_0;
4308
    PushItemWidth(width * 0.65f);
4309
    window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f);
4310
    window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4311
    window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding;
4312
    window->WorkRect.Max.y = window->ContentRegionRect.Max.y;
4313
}
4314
4315
void ImGui::NextColumn()
4316
{
4317
    ImGuiWindow* window = GetCurrentWindow();
4318
    if (window->SkipItems || window->DC.CurrentColumns == NULL)
4319
        return;
4320
4321
    ImGuiContext& g = *GImGui;
4322
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4323
4324
    if (columns->Count == 1)
4325
    {
4326
        window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4327
        IM_ASSERT(columns->Current == 0);
4328
        return;
4329
    }
4330
4331
    // Next column
4332
    if (++columns->Current == columns->Count)
4333
        columns->Current = 0;
4334
4335
    PopItemWidth();
4336
4337
    // Optimization: avoid PopClipRect() + SetCurrentChannel() + PushClipRect()
4338
    // (which would needlessly attempt to update commands in the wrong channel, then pop or overwrite them),
4339
    ImGuiOldColumnData* column = &columns->Columns[columns->Current];
4340
    SetWindowClipRectBeforeSetChannel(window, column->ClipRect);
4341
    columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1);
4342
4343
    const float column_padding = g.Style.ItemSpacing.x;
4344
    columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y);
4345
    if (columns->Current > 0)
4346
    {
4347
        // Columns 1+ ignore IndentX (by canceling it out)
4348
        // FIXME-COLUMNS: Unnecessary, could be locked?
4349
        window->DC.ColumnsOffset.x = GetColumnOffset(columns->Current) - window->DC.Indent.x + column_padding;
4350
    }
4351
    else
4352
    {
4353
        // New row/line: column 0 honor IndentX.
4354
        window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f);
4355
        window->DC.IsSameLine = false;
4356
        columns->LineMinY = columns->LineMaxY;
4357
    }
4358
    window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4359
    window->DC.CursorPos.y = columns->LineMinY;
4360
    window->DC.CurrLineSize = ImVec2(0.0f, 0.0f);
4361
    window->DC.CurrLineTextBaseOffset = 0.0f;
4362
4363
    // FIXME-COLUMNS: Share code with BeginColumns() - move code on columns setup.
4364
    float offset_0 = GetColumnOffset(columns->Current);
4365
    float offset_1 = GetColumnOffset(columns->Current + 1);
4366
    float width = offset_1 - offset_0;
4367
    PushItemWidth(width * 0.65f);
4368
    window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding;
4369
}
4370
4371
void ImGui::EndColumns()
4372
{
4373
    ImGuiContext& g = *GImGui;
4374
    ImGuiWindow* window = GetCurrentWindow();
4375
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4376
    IM_ASSERT(columns != NULL);
4377
4378
    PopItemWidth();
4379
    if (columns->Count > 1)
4380
    {
4381
        PopClipRect();
4382
        columns->Splitter.Merge(window->DrawList);
4383
    }
4384
4385
    const ImGuiOldColumnFlags flags = columns->Flags;
4386
    columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y);
4387
    window->DC.CursorPos.y = columns->LineMaxY;
4388
    if (!(flags & ImGuiOldColumnFlags_GrowParentContentsSize))
4389
        window->DC.CursorMaxPos.x = columns->HostCursorMaxPosX;  // Restore cursor max pos, as columns don't grow parent
4390
4391
    // Draw columns borders and handle resize
4392
    // The IsBeingResized flag ensure we preserve pre-resize columns width so back-and-forth are not lossy
4393
    bool is_being_resized = false;
4394
    if (!(flags & ImGuiOldColumnFlags_NoBorder) && !window->SkipItems)
4395
    {
4396
        // We clip Y boundaries CPU side because very long triangles are mishandled by some GPU drivers.
4397
        const float y1 = ImMax(columns->HostCursorPosY, window->ClipRect.Min.y);
4398
        const float y2 = ImMin(window->DC.CursorPos.y, window->ClipRect.Max.y);
4399
        int dragging_column = -1;
4400
        for (int n = 1; n < columns->Count; n++)
4401
        {
4402
            ImGuiOldColumnData* column = &columns->Columns[n];
4403
            float x = window->Pos.x + GetColumnOffset(n);
4404
            const ImGuiID column_id = columns->ID + ImGuiID(n);
4405
            const float column_hit_hw = ImTrunc(COLUMNS_HIT_RECT_HALF_THICKNESS * g.CurrentDpiScale);
4406
            const ImRect column_hit_rect(ImVec2(x - column_hit_hw, y1), ImVec2(x + column_hit_hw, y2));
4407
            if (!ItemAdd(column_hit_rect, column_id, NULL, ImGuiItemFlags_NoNav))
4408
                continue;
4409
4410
            bool hovered = false, held = false;
4411
            if (!(flags & ImGuiOldColumnFlags_NoResize))
4412
            {
4413
                ButtonBehavior(column_hit_rect, column_id, &hovered, &held);
4414
                if (hovered || held)
4415
                    SetMouseCursor(ImGuiMouseCursor_ResizeEW);
4416
                if (held && !(column->Flags & ImGuiOldColumnFlags_NoResize))
4417
                    dragging_column = n;
4418
            }
4419
4420
            // Draw column
4421
            const ImU32 col = GetColorU32(held ? ImGuiCol_SeparatorActive : hovered ? ImGuiCol_SeparatorHovered : ImGuiCol_Separator);
4422
            const float xi = IM_TRUNC(x);
4423
            window->DrawList->AddLine(ImVec2(xi, y1 + 1.0f), ImVec2(xi, y2), col);
4424
        }
4425
4426
        // Apply dragging after drawing the column lines, so our rendered lines are in sync with how items were displayed during the frame.
4427
        if (dragging_column != -1)
4428
        {
4429
            if (!columns->IsBeingResized)
4430
                for (int n = 0; n < columns->Count + 1; n++)
4431
                    columns->Columns[n].OffsetNormBeforeResize = columns->Columns[n].OffsetNorm;
4432
            columns->IsBeingResized = is_being_resized = true;
4433
            float x = GetDraggedColumnOffset(columns, dragging_column);
4434
            SetColumnOffset(dragging_column, x);
4435
        }
4436
    }
4437
    columns->IsBeingResized = is_being_resized;
4438
4439
    window->WorkRect = window->ParentWorkRect;
4440
    window->ParentWorkRect = columns->HostBackupParentWorkRect;
4441
    window->DC.CurrentColumns = NULL;
4442
    window->DC.ColumnsOffset.x = 0.0f;
4443
    window->DC.CursorPos.x = IM_TRUNC(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
4444
    NavUpdateCurrentWindowIsScrollPushableX();
4445
}
4446
4447
void ImGui::Columns(int columns_count, const char* id, bool borders)
4448
{
4449
    ImGuiWindow* window = GetCurrentWindow();
4450
    IM_ASSERT(columns_count >= 1);
4451
4452
    ImGuiOldColumnFlags flags = (borders ? 0 : ImGuiOldColumnFlags_NoBorder);
4453
    //flags |= ImGuiOldColumnFlags_NoPreserveWidths; // NB: Legacy behavior
4454
    ImGuiOldColumns* columns = window->DC.CurrentColumns;
4455
    if (columns != NULL && columns->Count == columns_count && columns->Flags == flags)
4456
        return;
4457
4458
    if (columns != NULL)
4459
        EndColumns();
4460
4461
    if (columns_count != 1)
4462
        BeginColumns(id, columns_count, flags);
4463
}
4464
4465
//-------------------------------------------------------------------------
4466
4467
#endif // #ifndef IMGUI_DISABLE