Skip to content

Properly Visualize the Filter Messages in the UI #1003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dj-bauer wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Properly Visualize the Filter Messages in the UI #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54a91da
Use new Messages struct instead of Errors from FlowGraphNode
dj-bauer Jun 9, 2026
8ef2a36
Properly set outline colors for individual message levels
dj-bauer Jun 9, 2026
acaf385
FlowGraphNode messages
dj-bauer Jun 9, 2026
1457310
Instead of setting 0 for outline colors in filtergraph editor for err…
dj-bauer Jun 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib
Open in desktop
Submodule lib updated 3 files
+16 −0 scopehal/FlowGraphNode.cpp
+52 −23 scopehal/FlowGraphNode.h
+2 −2 scopeprotocols/EyePattern.cpp
22 changes: 17 additions & 5 deletions src/ngscopeclient/FilterGraphEditor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2141,7 +2141,16 @@ void FilterGraphEditor::DoNodeForChannel(
displaycolor = "#808080";

auto& prefs = m_session->GetPreferences();
auto errorColor = prefs.GetColor("Appearance.Filter Graph.error_outline_color");
ImU32 messageColors[] = {
prefs.GetColor("Appearance.Filter Graph.error_outline_color"), // 0 zero in enum is not set, therefore placeholder
prefs.GetColor("Appearance.Filter Graph.error_outline_color"), // Also no fatal error should be ever sent, but better than crash
prefs.GetColor("Appearance.Filter Graph.error_outline_color"),
prefs.GetColor("Appearance.Filter Graph.warning_outline_color"),
prefs.GetColor("Appearance.Filter Graph.notice_outline_color"),
prefs.GetColor("Appearance.Filter Graph.verbose_outline_color"),
prefs.GetColor("Appearance.Filter Graph.debug_outline_color"),
prefs.GetColor("Appearance.Filter Graph.debug_outline_color"), // We don't need crash, so placeholder
};

//Get some configuration / style settings
auto color = ColorFromString(displaycolor);
Expand Down Expand Up @@ -2371,9 +2380,11 @@ void FilterGraphEditor::DoNodeForChannel(
}

//Display errors
if(channel->HasErrors())
if(channel->HasMessages())
{
auto errorText = channel->GetErrorTitle();
// We only display the most severe message for now
auto msg = channel->GetMostSevereMessage();
auto errorText = msg->GetTitle();
auto errorSize = ImGui::CalcTextSize(errorText.c_str());

auto textColor = ImGui::GetColorU32(ImGui::GetStyleColorVec4(ImGuiCol_Text));
Expand All @@ -2398,7 +2409,7 @@ void FilterGraphEditor::DoNodeForChannel(
if( (mousepos.x > rectStart.x) && (mousepos.y > rectStart.y) &&
(mousepos.x < rectEnd.x) && (mousepos.y < rectEnd.y) )
{
auto log = Trim(channel->GetErrorLog());
auto log = Trim(msg->GetMessage());

ax::NodeEditor::Suspend();
MainWindow::SetTooltipPosition();
Expand All @@ -2412,7 +2423,8 @@ void FilterGraphEditor::DoNodeForChannel(

//Draw outline rectangle around the entire filter
auto errorOutlineThickness = 0.4 * ImGui::GetFontSize();
bgList->AddRect(pos, pos+size, errorColor, rounding, ImDrawFlags_RoundCornersAll, errorOutlineThickness);
auto outlineColor = messageColors[static_cast<int>(msg->GetSeverity())];
bgList->AddRect(pos, pos+size, outlineColor, rounding, ImDrawFlags_RoundCornersAll, errorOutlineThickness);
}

ImGui::PopFont(); // headerfont
Expand Down
29 changes: 16 additions & 13 deletions src/ngscopeclient/FilterGraphErrorWindow.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ bool FilterGraphErrorWindow::Render()
{
//Refresh list of errors
auto& nodes = Filter::GetAllInstances();
m_nodesWithErrors.clear();
m_nodesWithMessages.clear();
for(auto node : nodes)
{
if(node->HasErrors())
m_nodesWithErrors.emplace(node);
if(node->HasMessages())
m_nodesWithMessages.emplace(node);
}

//Show error window on first run, or if we have errors
if(!m_nodesWithErrors.empty())
if(!m_nodesWithMessages.empty())
m_open = true;
else if(m_firstRun)
{
Expand Down Expand Up @@ -97,27 +97,30 @@ bool FilterGraphErrorWindow::DoRender()
ImGuiTableFlags_SizingFixedFit;

auto width = ImGui::GetFontSize();
if(ImGui::BeginTable("table", 2, flags))
if(ImGui::BeginTable("table", 3, flags))
{
ImGui::TableSetupScrollFreeze(0, 1); //Header row does not scroll

ImGui::TableSetupColumn("Severity", ImGuiTableColumnFlags_WidthFixed, 6*width);
ImGui::TableSetupColumn("Channel", ImGuiTableColumnFlags_WidthFixed, 12*width);
ImGui::TableSetupColumn("Error", ImGuiTableColumnFlags_WidthStretch, 0);
ImGui::TableHeadersRow();

for(auto f : m_nodesWithErrors)
for(auto f : m_nodesWithMessages)
{
auto messages = explode(f->GetErrorLog(), '\n');
for(auto& m : messages)
for(auto& m : f->GetMessages())
{
//remove bullet and space
string s = m.substr(m.find(' ') + 1);

// TODO: Combine this with logging library and merge the enum-Str mapping
const char* severity_str[] = {
"NOTHING", "FATAL", "ERROR", "WARNING", "NOTICE", "VERBOSE", "DEBUG", "TRACE"
};
ImGui::TableNextRow(ImGuiTableRowFlags_None);
ImGui::TableSetColumnIndex(0);
ImGui::TextUnformatted(f->GetDisplayName().c_str());
ImGui::TextUnformatted(severity_str[static_cast<int>(m.GetSeverity())]);
ImGui::TableSetColumnIndex(1);
ImGui::TextUnformatted(s.c_str());
ImGui::TextUnformatted(f->GetDisplayName().c_str());
ImGui::TableSetColumnIndex(2);
ImGui::TextUnformatted(m.GetMessage().c_str());
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/ngscopeclient/FilterGraphErrorWindow.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class FilterGraphErrorWindow : public Dialog
virtual bool DoRender();

protected:
std::set<InstrumentChannel*> m_nodesWithErrors;
std::set<InstrumentChannel*> m_nodesWithMessages;
bool m_firstRun;
};

Expand Down
25 changes: 21 additions & 4 deletions src/ngscopeclient/PreferenceSchema.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,6 @@ void PreferenceManager::InitializeDefaults()
Preference::Color("infobubble_color", ColorFromString("#404040"))
.Label("Info bubble color")
.Description("Color for information bubbles displayed above graph nodes"));
graph.AddPreference(
Preference::Color("error_outline_color", ColorFromString("#ff0000"))
.Label("Error outline color")
.Description("Color for outlining graph nodes with errors"));
graph.AddPreference(
Preference::Font("icon_caption_font", FontDescription(FindDataFile("fonts/DejaVuSans.ttf"), 13))
.Label("Icon font")
Expand All @@ -174,6 +170,27 @@ void PreferenceManager::InitializeDefaults()
.Label("Icon color")
.Description("Color for icon captions"));

graph.AddPreference(
Preference::Color("error_outline_color", ColorFromString("#ff0000"))
.Label("Error outline color")
.Description("Color for outlining graph nodes with errors"));
graph.AddPreference(
Preference::Color("warning_outline_color", ColorFromString("#ffff00"))
.Label("Warning outline color")
.Description("Color for outlining graph nodes with warnings"));
graph.AddPreference(
Preference::Color("notice_outline_color", ColorFromString("#00ff00"))
.Label("Notice outline color")
.Description("Color for outlining graph nodes with notice messages"));
graph.AddPreference(
Preference::Color("verbose_outline_color", ColorFromString("#a0a0ff"))
.Label("Verbose outline color")
.Description("Color for outlining graph nodes with verbose messages"));
graph.AddPreference(
Preference::Color("debug_outline_color", ColorFromString("#a0a0a0"))
.Label("Debug outline color")
.Description("Color for outlining graph nodes with debug messages"));

auto& ahelp = appearance.AddCategory("Help");
ahelp.AddPreference(
Preference::Color("bubble_outline_color", ColorFromString("#00ff00"))
Expand Down