#include "Search.hpp" #include #include #include #include #include #include "wx/dataview.h" #include "libslic3r/PrintConfig.hpp" #include "libslic3r/PresetBundle.hpp" #include "GUI_App.hpp" #include "Plater.hpp" #include "Tab.hpp" #define FTS_FUZZY_MATCH_IMPLEMENTATION #include "fts_fuzzy_match.h" #include "imgui/imconfig.h" using boost::optional; namespace Slic3r { using GUI::from_u8; using GUI::into_u8; namespace Search { // Does our wxWidgets version support markup? // https://github.com/prusa3d/PrusaSlicer/issues/4282#issuecomment-634676371 #if wxUSE_MARKUP && wxCHECK_VERSION(3, 1, 1) #define SEARCH_SUPPORTS_MARKUP #endif static char marker_by_type(Preset::Type type, PrinterTechnology pt) { switch(type) { case Preset::TYPE_PRINT: case Preset::TYPE_SLA_PRINT: return ImGui::PrintIconMarker; case Preset::TYPE_FILAMENT: return ImGui::FilamentIconMarker; case Preset::TYPE_SLA_MATERIAL: return ImGui::MaterialIconMarker; case Preset::TYPE_PRINTER: return pt == ptSLA ? ImGui::PrinterSlaIconMarker : ImGui::PrinterIconMarker; default: return ' '; } } void FoundOption::get_marked_label_and_tooltip(const char** label_, const char** tooltip_) const { *label_ = marked_label.c_str(); *tooltip_ = tooltip.c_str(); } template //void change_opt_key(std::string& opt_key, DynamicPrintConfig* config) void change_opt_key(std::string& opt_key, DynamicPrintConfig* config, int& cnt) { T* opt_cur = static_cast(config->option(opt_key)); cnt = opt_cur->values.size(); return; if (opt_cur->values.size() > 0) opt_key += "#" + std::to_string(0); } void OptionsSearcher::append_options(DynamicPrintConfig* config, Preset::Type type, ConfigOptionMode mode) { auto emplace = [this, type](const std::string opt_key, const wxString& label) { const GroupAndCategory& gc = groups_and_categories[opt_key]; if (gc.group.IsEmpty() || gc.category.IsEmpty()) return; wxString suffix; wxString suffix_local; if (gc.category == "Machine limits") { suffix = opt_key.back()=='1' ? L("Stealth") : L("Normal"); suffix_local = " " + _(suffix); suffix = " " + suffix; } if (!label.IsEmpty()) options.emplace_back(Option{ boost::nowide::widen(opt_key), type, (label + suffix).ToStdWstring(), (_(label) + suffix_local).ToStdWstring(), gc.group.ToStdWstring(), _(gc.group).ToStdWstring(), gc.category.ToStdWstring(), _(gc.category).ToStdWstring() }); }; for (std::string opt_key : config->keys()) { const ConfigOptionDef& opt = config->def()->options.at(opt_key); if (opt.mode > mode) continue; int cnt = 0; if ( (type == Preset::TYPE_SLA_MATERIAL || type == Preset::TYPE_PRINTER) && opt_key != "bed_shape") switch (config->option(opt_key)->type()) { case coInts: change_opt_key(opt_key, config, cnt); break; case coBools: change_opt_key(opt_key, config, cnt); break; case coFloats: change_opt_key(opt_key, config, cnt); break; case coStrings: change_opt_key(opt_key, config, cnt); break; case coPercents:change_opt_key(opt_key, config, cnt); break; case coPoints: change_opt_key(opt_key, config, cnt); break; default: break; } wxString label = opt.full_label.empty() ? opt.label : opt.full_label; if (cnt == 0) emplace(opt_key, label); else for (int i = 0; i < cnt; ++i) // ! It's very important to use "#". opt_key#n is a real option key used in GroupAndCategory emplace(opt_key + "#" + std::to_string(i), label); } } // Wrap a string with ColorMarkerStart and ColorMarkerEnd symbols static wxString wrap_string(const wxString& str) { return wxString::Format("%c%s%c", ImGui::ColorMarkerStart, str, ImGui::ColorMarkerEnd); } // Mark a string using ColorMarkerStart and ColorMarkerEnd symbols static std::wstring mark_string(const std::wstring &str, const std::vector &matches) { std::wstring out; if (matches.empty()) out = str; else { out.reserve(str.size() * 2); if (matches.front() > 0) out += str.substr(0, matches.front()); for (size_t i = 0;;) { // Find the longest string of successive indices. size_t j = i + 1; while (j < matches.size() && matches[j] == matches[j - 1] + 1) ++ j; out += ImGui::ColorMarkerStart; out += str.substr(matches[i], matches[j - 1] - matches[i] + 1); out += ImGui::ColorMarkerEnd; if (j == matches.size()) { out += str.substr(matches[j - 1] + 1); break; } out += str.substr(matches[j - 1] + 1, matches[j] - matches[j - 1] - 1); i = j; } } return out; } bool OptionsSearcher::search() { return search(search_line, true); } static bool fuzzy_match(const std::wstring &search_pattern, const std::wstring &label, int& out_score, std::vector &out_matches) { uint16_t matches[fts::max_matches + 1]; // +1 for the stopper int score; if (fts::fuzzy_match(search_pattern.c_str(), label.c_str(), score, matches)) { size_t cnt = 0; for (; matches[cnt] != fts::stopper; ++cnt); out_matches.assign(matches, matches + cnt); out_score = score; return true; } else return false; } bool OptionsSearcher::search(const std::string& search, bool force/* = false*/) { if (search_line == search && !force) return false; found.clear(); bool full_list = search.empty(); std::wstring sep = L" : "; auto get_label = [this, &sep](const Option& opt) { std::wstring out; out += marker_by_type(opt.type, printer_technology); const std::wstring *prev = nullptr; for (const std::wstring * const s : { view_params.category ? &opt.category_local : nullptr, &opt.group_local, &opt.label_local }) if (s != nullptr && (prev == nullptr || *prev != *s)) { if (out.size()>2) out += sep; out += *s; prev = s; } return out; }; auto get_label_english = [this, &sep](const Option& opt) { std::wstring out; out += marker_by_type(opt.type, printer_technology); const std::wstring*prev = nullptr; for (const std::wstring * const s : { view_params.category ? &opt.category : nullptr, &opt.group, &opt.label }) if (s != nullptr && (prev == nullptr || *prev != *s)) { if (out.size()>2) out += sep; out += *s; prev = s; } return out; }; auto get_tooltip = [this, &sep](const Option& opt) { return marker_by_type(opt.type, printer_technology) + opt.category_local + sep + opt.group_local + sep + opt.label_local; }; std::vector matches, matches2; for (size_t i=0; i < options.size(); i++) { const Option &opt = options[i]; if (full_list) { std::string label = into_u8(get_label(opt)); found.emplace_back(FoundOption{ label, label, boost::nowide::narrow(get_tooltip(opt)), i, 0 }); continue; } std::wstring wsearch = boost::nowide::widen(search); boost::trim_left(wsearch); std::wstring label = get_label(opt); std::wstring label_english = get_label_english(opt); int score = std::numeric_limits::min(); int score2; matches.clear(); fuzzy_match(wsearch, label, score, matches); if (fuzzy_match(wsearch, opt.opt_key, score2, matches2) && score2 > score) { for (fts::pos_type &pos : matches2) pos += label.size() + 1; label += L"(" + opt.opt_key + L")"; append(matches, matches2); score = score2; } if (view_params.english && fuzzy_match(wsearch, label_english, score2, matches2) && score2 > score) { label = std::move(label_english); matches = std::move(matches2); score = score2; } if (score > std::numeric_limits::min()) { label = mark_string(label, matches); label += L" [" + std::to_wstring(score) + L"]";// add score value std::string label_u8 = into_u8(label); std::string label_plain = label_u8; #ifdef SEARCH_SUPPORTS_MARKUP boost::replace_all(label_plain, std::string(1, char(ImGui::ColorMarkerStart)), ""); boost::replace_all(label_plain, std::string(1, char(ImGui::ColorMarkerEnd)), ""); #else boost::erase_all(label_plain, std::string(1, char(ImGui::ColorMarkerStart))); boost::erase_all(label_plain, std::string(1, char(ImGui::ColorMarkerEnd))); #endif found.emplace_back(FoundOption{ label_plain, label_u8, boost::nowide::narrow(get_tooltip(opt)), i, score }); } } if (!full_list) sort_found(); if (search_line != search) search_line = search; return true; } OptionsSearcher::OptionsSearcher() { search_dialog = new SearchDialog(this); } OptionsSearcher::~OptionsSearcher() { if (search_dialog) search_dialog->Destroy(); } void OptionsSearcher::init(std::vector input_values) { options.clear(); for (auto i : input_values) append_options(i.config, i.type, i.mode); sort_options(); search(search_line, true); } void OptionsSearcher::apply(DynamicPrintConfig* config, Preset::Type type, ConfigOptionMode mode) { if (options.empty()) return; options.erase(std::remove_if(options.begin(), options.end(), [type](Option opt) { return opt.type == type; }), options.end()); append_options(config, type, mode); sort_options(); search(search_line, true); } const Option& OptionsSearcher::get_option(size_t pos_in_filter) const { assert(pos_in_filter != size_t(-1) && found[pos_in_filter].option_idx != size_t(-1)); return options[found[pos_in_filter].option_idx]; } void OptionsSearcher::add_key(const std::string& opt_key, const wxString& group, const wxString& category) { groups_and_categories[opt_key] = GroupAndCategory{group, category}; } //------------------------------------------ // SearchComboPopup //------------------------------------------ void SearchComboPopup::Init() { this->Bind(wxEVT_MOTION, &SearchComboPopup::OnMouseMove, this); this->Bind(wxEVT_LEFT_UP, &SearchComboPopup::OnMouseClick, this); this->Bind(wxEVT_KEY_DOWN, &SearchComboPopup::OnKeyDown, this); } bool SearchComboPopup::Create(wxWindow* parent) { return wxListBox::Create(parent, 1, wxPoint(0, 0), wxDefaultSize); } void SearchComboPopup::SetStringValue(const wxString& s) { int n = wxListBox::FindString(s); if (n >= 0 && n < int(wxListBox::GetCount())) wxListBox::Select(n); // save a combo control's string m_input_string = s; } void SearchComboPopup::ProcessSelection(int selection) { wxCommandEvent event(wxEVT_LISTBOX, GetId()); event.SetInt(selection); event.SetEventObject(this); ProcessEvent(event); Dismiss(); } void SearchComboPopup::OnMouseMove(wxMouseEvent& event) { wxPoint pt = wxGetMousePosition() - this->GetScreenPosition(); int selection = this->HitTest(pt); wxListBox::Select(selection); } void SearchComboPopup::OnMouseClick(wxMouseEvent&) { int selection = wxListBox::GetSelection(); SetSelection(wxNOT_FOUND); ProcessSelection(selection); } void SearchComboPopup::OnKeyDown(wxKeyEvent& event) { int key = event.GetKeyCode(); // change selected item in the list if (key == WXK_UP || key == WXK_DOWN) { int selection = wxListBox::GetSelection(); if (key == WXK_UP && selection > 0) selection--; if (key == WXK_DOWN && selection < int(wxListBox::GetCount() - 1)) selection++; wxListBox::Select(selection); } // send wxEVT_LISTBOX event if "Enter" was pushed else if (key == WXK_NUMPAD_ENTER || key == WXK_RETURN) ProcessSelection(wxListBox::GetSelection()); else event.Skip(); // !Needed to have EVT_CHAR generated as well } //------------------------------------------ // SearchDialog //------------------------------------------ static const std::map icon_idxs = { {ImGui::PrintIconMarker , 0}, {ImGui::PrinterIconMarker , 1}, {ImGui::PrinterSlaIconMarker, 2}, {ImGui::FilamentIconMarker , 3}, {ImGui::MaterialIconMarker , 4}, }; SearchDialog::SearchDialog(OptionsSearcher* searcher) : GUI::DPIDialog(NULL, wxID_ANY, _L("Search"), wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER), searcher(searcher) { SetFont(GUI::wxGetApp().normal_font()); wxColour bgr_clr = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW); SetBackgroundColour(bgr_clr); default_string = _L("Type here to search"); int border = 10; int em = em_unit(); search_line = new wxTextCtrl(this, wxID_ANY, "", wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER); search_list = new wxDataViewCtrl(this, wxID_ANY, wxDefaultPosition, wxSize(em * 40, em * 30), wxDV_NO_HEADER | wxDV_SINGLE | wxBORDER_SIMPLE); search_list_model = new SearchListModel(this); search_list->AssociateModel(search_list_model); search_list->AppendBitmapColumn("", SearchListModel::colIcon); wxDataViewTextRenderer* const markupRenderer = new wxDataViewTextRenderer(); #ifdef SEARCH_SUPPORTS_MARKUP markupRenderer->EnableMarkup(); #endif search_list->AppendColumn(new wxDataViewColumn("", markupRenderer, SearchListModel::colMarkedText, wxCOL_WIDTH_AUTOSIZE, wxALIGN_LEFT)); search_list->GetColumn(SearchListModel::colIcon )->SetWidth(3 * em_unit()); search_list->GetColumn(SearchListModel::colMarkedText)->SetWidth(40 * em_unit()); wxBoxSizer* check_sizer = new wxBoxSizer(wxHORIZONTAL); check_category = new wxCheckBox(this, wxID_ANY, _L("Category")); if (GUI::wxGetApp().is_localized()) check_english = new wxCheckBox(this, wxID_ANY, _L("Search in English")); wxStdDialogButtonSizer* cancel_btn = this->CreateStdDialogButtonSizer(wxCANCEL); check_sizer->Add(new wxStaticText(this, wxID_ANY, _L("Use for search") + ":"), 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, border); check_sizer->Add(check_category, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, border); if (check_english) check_sizer->Add(check_english, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, border); check_sizer->AddStretchSpacer(border); check_sizer->Add(cancel_btn, 0, wxALIGN_CENTER_VERTICAL); wxBoxSizer* topSizer = new wxBoxSizer(wxVERTICAL); topSizer->Add(search_line, 0, wxEXPAND | wxLEFT | wxTOP | wxRIGHT, border); topSizer->Add(search_list, 1, wxEXPAND | wxLEFT | wxTOP | wxRIGHT, border); topSizer->Add(check_sizer, 0, wxEXPAND | wxALL, border); search_line->Bind(wxEVT_TEXT, &SearchDialog::OnInputText, this); search_line->Bind(wxEVT_LEFT_UP, &SearchDialog::OnLeftUpInTextCtrl, this); // process wxEVT_KEY_DOWN to navigate inside search_list, if ArrowUp/Down was pressed search_line->Bind(wxEVT_KEY_DOWN,&SearchDialog::OnKeyDown, this); search_list->Bind(wxEVT_DATAVIEW_SELECTION_CHANGED, &SearchDialog::OnSelect, this); search_list->Bind(wxEVT_DATAVIEW_ITEM_ACTIVATED, &SearchDialog::OnActivate, this); #ifdef __WXMSW__ search_list->GetMainWindow()->Bind(wxEVT_MOTION, &SearchDialog::OnMotion, this); search_list->GetMainWindow()->Bind(wxEVT_LEFT_DOWN, &SearchDialog::OnLeftDown, this); #endif //__WXMSW__ // Under OSX mouse and key states didn't fill after wxEVT_DATAVIEW_SELECTION_CHANGED call // As a result, we can't to identify what kind of actions was done // So, under OSX is used OnKeyDown function to navigate inside the list #ifdef __APPLE__ search_list->Bind(wxEVT_KEY_DOWN, &SearchDialog::OnKeyDown, this); #endif check_category->Bind(wxEVT_CHECKBOX, &SearchDialog::OnCheck, this); if (check_english) check_english ->Bind(wxEVT_CHECKBOX, &SearchDialog::OnCheck, this); // Bind(wxEVT_MOTION, &SearchDialog::OnMotion, this); Bind(wxEVT_LEFT_DOWN, &SearchDialog::OnLeftDown, this); SetSizer(topSizer); topSizer->SetSizeHints(this); } void SearchDialog::Popup(wxPoint position /*= wxDefaultPosition*/) { const std::string& line = searcher->search_string(); search_line->SetValue(line.empty() ? default_string : from_u8(line)); search_line->SetFocus(); search_line->SelectAll(); update_list(); const OptionViewParameters& params = searcher->view_params; check_category->SetValue(params.category); if (check_english) check_english->SetValue(params.english); this->SetPosition(position); this->ShowModal(); } void SearchDialog::ProcessSelection(wxDataViewItem selection) { if (!selection.IsOk()) return; GUI::wxGetApp().sidebar().jump_to_option(search_list_model->GetRow(selection)); this->EndModal(wxID_CLOSE); } void SearchDialog::OnInputText(wxCommandEvent&) { search_line->SetInsertionPointEnd(); wxString input_string = search_line->GetValue(); if (input_string == default_string) input_string.Clear(); searcher->search(into_u8(input_string)); update_list(); } void SearchDialog::OnLeftUpInTextCtrl(wxEvent& event) { if (search_line->GetValue() == default_string) search_line->SetValue(""); event.Skip(); } void SearchDialog::OnKeyDown(wxKeyEvent& event) { int key = event.GetKeyCode(); // change selected item in the list if (key == WXK_UP || key == WXK_DOWN) { // So, for the next correct navigation, set focus on the search_list search_list->SetFocus(); auto item = search_list->GetSelection(); if (item.IsOk()) { unsigned selection = search_list_model->GetRow(item); if (key == WXK_UP && selection > 0) selection--; if (key == WXK_DOWN && selection < unsigned(search_list_model->GetCount() - 1)) selection++; prevent_list_events = true; search_list->Select(search_list_model->GetItem(selection)); prevent_list_events = false; } } // process "Enter" pressed else if (key == WXK_NUMPAD_ENTER || key == WXK_RETURN) ProcessSelection(search_list->GetSelection()); else event.Skip(); // !Needed to have EVT_CHAR generated as well } void SearchDialog::OnActivate(wxDataViewEvent& event) { ProcessSelection(event.GetItem()); } void SearchDialog::OnSelect(wxDataViewEvent& event) { // To avoid selection update from Select() under osx if (prevent_list_events) return; // Under OSX mouse and key states didn't fill after wxEVT_DATAVIEW_SELECTION_CHANGED call // As a result, we can't to identify what kind of actions was done // So, under OSX is used OnKeyDown function to navigate inside the list #ifndef __APPLE__ // wxEVT_DATAVIEW_SELECTION_CHANGED is processed, when selection is changed after mouse click or press the Up/Down arrows // But this two cases should be processed in different way: // Up/Down arrows -> leave it as it is (just a navigation) // LeftMouseClick -> call the ProcessSelection function if (wxGetMouseState().LeftIsDown()) #endif //__APPLE__ ProcessSelection(search_list->GetSelection()); } void SearchDialog::update_list() { // Under OSX model->Clear invoke wxEVT_DATAVIEW_SELECTION_CHANGED, so // set prevent_list_events to true already here prevent_list_events = true; search_list_model->Clear(); const std::vector& filters = searcher->found_options(); for (const FoundOption& item : filters) search_list_model->Prepend(item.label); // select first item, if search_list if (search_list_model->GetCount() > 0) search_list->Select(search_list_model->GetItem(0)); prevent_list_events = false; } void SearchDialog::OnCheck(wxCommandEvent& event) { OptionViewParameters& params = searcher->view_params; if (check_english) params.english = check_english->GetValue(); params.category = check_category->GetValue(); searcher->search(); update_list(); } void SearchDialog::OnMotion(wxMouseEvent& event) { wxDataViewItem item; wxDataViewColumn* col; wxWindow* win = this; #ifdef __WXMSW__ win = search_list; #endif search_list->HitTest(wxGetMousePosition() - win->GetScreenPosition(), item, col); search_list->Select(item); event.Skip(); } void SearchDialog::OnLeftDown(wxMouseEvent& event) { ProcessSelection(search_list->GetSelection()); } void SearchDialog::on_dpi_changed(const wxRect& suggested_rect) { const int& em = em_unit(); search_list_model->msw_rescale(); search_list->GetColumn(SearchListModel::colIcon )->SetWidth(3 * em); search_list->GetColumn(SearchListModel::colMarkedText)->SetWidth(45 * em); msw_buttons_rescale(this, em, { wxID_CANCEL }); const wxSize& size = wxSize(40 * em, 30 * em); SetMinSize(size); Fit(); Refresh(); } void SearchDialog::on_sys_color_changed() { // msw_rescale updates just icons, so use it search_list_model->msw_rescale(); Refresh(); } // ---------------------------------------------------------------------------- // SearchListModel // ---------------------------------------------------------------------------- SearchListModel::SearchListModel(wxWindow* parent) : wxDataViewVirtualListModel(0) { int icon_id = 0; for (const std::string& icon : { "cog", "printer", "sla_printer", "spool", "resin" }) m_icon[icon_id++] = ScalableBitmap(parent, icon); } void SearchListModel::Clear() { m_values.clear(); Reset(0); } void SearchListModel::Prepend(const std::string& label) { const char icon_c = label.at(0); int icon_idx = icon_idxs.at(icon_c); wxString str = from_u8(label).Remove(0, 1); m_values.emplace_back(str, icon_idx); RowPrepended(); } void SearchListModel::msw_rescale() { for (ScalableBitmap& bmp : m_icon) bmp.msw_rescale(); } wxString SearchListModel::GetColumnType(unsigned int col) const { if (col == colIcon) return "wxBitmap"; return "string"; } void SearchListModel::GetValueByRow(wxVariant& variant, unsigned int row, unsigned int col) const { switch (col) { case colIcon: variant << m_icon[m_values[row].second].bmp(); break; case colMarkedText: variant = m_values[row].first; break; case colMax: wxFAIL_MSG("invalid column"); default: break; } } } } // namespace Slic3r::GUI