Tag Support expanded in a couple of ways (#6664)

1. Shift-Save adds a tag field
2. Tag field gets saved and restored consistently
3. tag field injected into sql db
4. Tag field used in plain text search in sql

Closes #6663

src/common/PatchDB.cpp

@@ -227,9 +227,8 @@ struct TxnGuard
 
 struct PatchDB::WriterWorker
 {
-    static constexpr const char *schema_version = "11"; // I will rebuild if this is not my version
+    static constexpr const char *schema_version = "14"; // I will rebuild if this is not my version
 
-    // language=SQL
     static constexpr const char *setup_sql = R"SQL(
 DROP TABLE IF EXISTS "Patches";
 DROP TABLE IF EXISTS "PatchFeature";
@@ -244,6 +243,7 @@ CREATE TABLE "Patches" (
       id integer primary key,
       path varchar(2048),
       name varchar(256),
+      search_over varchar(1024),
       category varchar(2048),
       category_type int,
       last_write_time big int
@@ -562,6 +562,17 @@ CREATE TABLE IF NOT EXISTS Favorites (
             {
                 res.emplace_back("AUTHOR", STRING, 0, meta->Attribute("author"));
             }
+
+            auto tags = TINYXML_SAFE_TO_ELEMENT(meta->FirstChild("tags"));
+            if (tags)
+            {
+                auto tag = tags->FirstChildElement();
+                while (tag)
+                {
+                    res.emplace_back("TAG", STRING, 0, tag->Attribute("tag"));
+                    tag = tag->NextSiblingElement();
+                }
+            }
         }
 
         auto parameters = TINYXML_SAFE_TO_ELEMENT(patch->FirstChild("parameters"));
@@ -801,6 +812,9 @@ CREATE TABLE IF NOT EXISTS Favorites (
             return;
         }
 
+        std::ostringstream searchName;
+        searchName << p.name << " ";
+
         std::ifstream stream(p.path, std::ios::in | std::ios::binary);
         std::vector<uint8_t> contents((std::istreambuf_iterator<char>(stream)),
                                       std::istreambuf_iterator<char>());
@@ -862,6 +876,7 @@ CREATE TABLE IF NOT EXISTS Favorites (
             auto feat = extractFeaturesFromXML(xml);
             for (auto f : feat)
             {
+                auto ftype = std::get<0>(f);
                 ins.bindi64(1, patchid);
                 ins.bind(2, std::get<0>(f));
                 ins.bind(3, (int)std::get<1>(f));
@@ -872,6 +887,10 @@ CREATE TABLE IF NOT EXISTS Favorites (
 
                 ins.clearBindings();
                 ins.reset();
+                if (ftype == "TAG")
+                {
+                    searchName << " " << std::get<3>(f);
+                }
             }
 
             ins.finalize();
@@ -881,6 +900,22 @@ CREATE TABLE IF NOT EXISTS Favorites (
             storage->reportError(e.what(), "PatchDB - FXP Features");
             return;
         }
+
+        auto sns = searchName.str();
+        try
+        {
+            auto ins = SQL::Statement(dbh, "UPDATE PATCHES SET search_over=?1 WHERE id=?2");
+            ins.bind(1, sns);
+            ins.bind(2, patchid);
+
+            ins.step();
+            ins.finalize();
+        }
+        catch (const SQL::Exception &e)
+        {
+            storage->reportError(e.what(), "PatchDB - FXP Features");
+            return;
+        }
     }
 
     void setFavorite(const std::string &p, bool v)
@@ -1420,7 +1455,7 @@ std::string PatchDB::sqlWhereClauseFor(const std::unique_ptr<PatchDBQueryParser:
         }
         break;
     case PatchDBQueryParser::LITERAL:
-        oss << "( p.name LIKE '%" << protect(t->content) << "%' )";
+        oss << "( p.search_over LIKE '%" << protect(t->content) << "%' )";
         break;
     case PatchDBQueryParser::AND:
     case PatchDBQueryParser::OR:
@@ -1448,7 +1483,7 @@ PatchDB::queryFromQueryString(const std::unique_ptr<PatchDBQueryParser::Token> &
 
     // FIXME - cache this by pushing it to the worker
     std::string query = "select p.id, p.path, p.category as category, p.name, pf.feature_svalue as "
-                        "author from Patches "
+                        "author, p.search_over from Patches "
                         "as p, PatchFeature as pf where pf.patch_id == p.id and pf.feature LIKE "
                         "'AUTHOR' and " +
                         sqlWhereClauseFor(t) + " ORDER BY p.category_type, p.category, p.name";

src/surge-testrunner/UnitTestsQUERY.cpp

@@ -135,27 +135,28 @@ TEST_CASE("SQL Generation", "[query]")
     {
         auto t = Surge::PatchStorage::PatchDBQueryParser::parseQuery("init");
         auto s = Surge::PatchStorage::PatchDB::sqlWhereClauseFor(t);
-        REQUIRE(s == "( p.name LIKE '%init%' )");
+        REQUIRE(s == "( p.search_over LIKE '%init%' )");
     }
 
     SECTION("Duple")
     {
         auto t = Surge::PatchStorage::PatchDBQueryParser::parseQuery("init sine");
         auto s = Surge::PatchStorage::PatchDB::sqlWhereClauseFor(t);
-        REQUIRE(s == "( ( p.name LIKE '%init%' ) AND ( p.name LIKE '%sine%' ) )");
+        REQUIRE(s == "( ( p.search_over LIKE '%init%' ) AND ( p.search_over LIKE '%sine%' ) )");
     }
 
     SECTION("Single Quote")
     {
         auto t = Surge::PatchStorage::PatchDBQueryParser::parseQuery("init 'sine");
         auto s = Surge::PatchStorage::PatchDB::sqlWhereClauseFor(t);
-        REQUIRE(s == "( ( p.name LIKE '%init%' ) AND ( p.name LIKE '%''sine%' ) )");
+        REQUIRE(s == "( ( p.search_over LIKE '%init%' ) AND ( p.search_over LIKE '%''sine%' ) )");
     }
 
     SECTION("Lots of Single Quotes Quote")
     {
         auto t = Surge::PatchStorage::PatchDBQueryParser::parseQuery("in'it' ''sine");
         auto s = Surge::PatchStorage::PatchDB::sqlWhereClauseFor(t);
-        REQUIRE(s == "( ( p.name LIKE '%in''it''%' ) AND ( p.name LIKE '%''''sine%' ) )");
+        REQUIRE(s ==
+                "( ( p.search_over LIKE '%in''it''%' ) AND ( p.search_over LIKE '%''''sine%' ) )");
     }
 }

src/surge-xt/gui/SurgeGUIEditorOverlays.cpp

@@ -97,6 +97,7 @@ std::unique_ptr<Surge::Overlays::OverlayComponent> SurgeGUIEditor::makeStorePatc
 
     // since it is now modal center in the window
     auto posRect = skinCtrl->getRect().withCentre(frame->getBounds().getCentre());
+
     pb->setEnclosingParentTitle("Save Patch");
     pb->setEnclosingParentPosition(posRect);
     pb->setHasIndependentClose(false);
@@ -405,6 +406,7 @@ std::unique_ptr<Surge::Overlays::OverlayComponent> SurgeGUIEditor::createOverlay
 
     return nullptr;
 }
+
 void SurgeGUIEditor::showOverlay(OverlayTags olt,
                                  std::function<void(Surge::Overlays::OverlayComponent *)> setup)
 {
@@ -416,13 +418,13 @@ void SurgeGUIEditor::showOverlay(OverlayTags olt,
         return;
     }
 
+    setup(ol.get());
+
     // copy these before the std::move below
     auto t = ol->getEnclosingParentTitle();
     auto r = ol->getEnclosingParentPosition();
     auto c = ol->getHasIndependentClose();
 
-    setup(ol.get());
-
     std::function<void()> onClose = []() {};
     bool isModal = false;
 
@@ -463,6 +465,7 @@ void SurgeGUIEditor::showOverlay(OverlayTags olt,
     default:
         break;
     }
+
     addJuceEditorOverlay(std::move(ol), t, olt, r, c, onClose, isModal);
 
     switch (olt)
@@ -492,6 +495,7 @@ void SurgeGUIEditor::showOverlay(OverlayTags olt,
 
     getOverlayIfOpen(olt)->grabKeyboardFocus();
 }
+
 void SurgeGUIEditor::closeOverlay(OverlayTags olt)
 {
     auto olw = getOverlayWrapperIfOpen(olt);

src/surge-xt/gui/SurgeGUIEditorValueCallbacks.cpp

@@ -36,11 +36,12 @@
 #include "widgets/Switch.h"
 #include "widgets/PatchSelector.h"
 #include "widgets/ParameterInfowindow.h"
+#include "widgets/WaveShaperSelector.h"
 #include "widgets/XMLConfiguredMenus.h"
 
-#include "overlays/TypeinParamEditor.h"
-#include "widgets/WaveShaperSelector.h"
 #include "overlays/ModulationEditor.h"
+#include "overlays/PatchStoreDialog.h"
+#include "overlays/TypeinParamEditor.h"
 
 std::string decodeControllerID(int id)
 {
@@ -3478,7 +3479,20 @@ void SurgeGUIEditor::valueChanged(Surge::GUI::IComponentTagValue *control)
     break;
     case tag_store:
     {
-        showOverlay(SAVE_PATCH);
+        bool showTags = juce::ModifierKeys::currentModifiers.isShiftDown() ||
+                        juce::ModifierKeys::currentModifiers.isAltDown();
+
+        showOverlay(SurgeGUIEditor::SAVE_PATCH,
+                    [this, showTags](Surge::Overlays::OverlayComponent *co) {
+                        auto psd = dynamic_cast<Surge::Overlays::PatchStoreDialog *>(co);
+
+                        if (!psd)
+                        {
+                            return;
+                        }
+
+                        psd->setShowTagsField(showTags);
+                    });
     }
     break;