feat: [WIP] Form.TagPicker support

Author: bpavuk

.gitignore

@@ -16,6 +16,7 @@ __cmake*
 *.tgz
 
 /qt6
+**/.qmlls.ini
 
 /AppDir
 *AppImage

CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.16)
 set(PROJECT_NAME vicinae)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(QT_QML_GENERATE_QMLLS_INI ON)
 project(${PROJECT_NAME} VERSION 1.0.0 LANGUAGES C CXX)
 
 set(LIB_NAMESPACE "vicinae")

flake.nix

@@ -63,6 +63,9 @@
             export CXX=${pkgs.gcc15}/bin/g++
             export CMAKE_C_COMPILER=$CC
             export CMAKE_CXX_COMPILER=$CXX
+
+            export QML2_IMPORT_PATH=${pkgs.qt6.qtdeclarative}/lib/qt-6/qml
+            export QML_IMPORT_PATH=${pkgs.qt6.qtdeclarative}/lib/qt-6/qml
           '';
         };
       });

src/server/CMakeLists.txt

@@ -504,6 +504,7 @@ set(SRCS
 	src/qml/extension-grid-model.hpp
 	src/qml/extension-grid-model.cpp
 	src/qml/source-blend-rect.hpp
+	src/qml/tag-search.hpp
 	src/qml/image-url.hpp
 	src/qml/image-url.cpp
 	src/qml/image-source.hpp
@@ -704,6 +705,7 @@ set(VICINAE_QML_FILES
 	src/qml/qml/FormTextArea.qml
 	src/qml/qml/FormCheckbox.qml
 	src/qml/qml/FormSeparator.qml
+	src/qml/qml/FormTagPicker.qml
 	src/qml/qml/SnippetFormView.qml
 	src/qml/qml/AliasFormView.qml
 	src/qml/qml/ShortcutFormView.qml
@@ -754,6 +756,7 @@ set(VICINAE_QML_FILES
 	src/qml/qml/MissingPreferenceView.qml
 	src/qml/qml/OAuthOverlayView.qml
 	src/qml/qml/HudWindow.qml
+	src/qml/qml/TagPickerTag.qml
 )
 
 # Strip directory prefix so resources are qrc:/Vicinae/Foo.qml

src/server/include/extend/form-model.hpp

@@ -2,6 +2,7 @@
 #include "extend/action-model.hpp"
 #include "extend/list-model.hpp"
 #include "extend/model.hpp"
+#include "extend/tag-model.hpp"
 #include <memory>
 #include <qcoreevent.h>
 #include <qjsonobject.h>
@@ -97,6 +98,14 @@ struct FormModel {
   public:
     DatePickerField(const FieldBase &base) : IField(base) {}
   };
+
+  struct TagPickerField : public IField {
+    std::vector<TagPickerItemModel> m_items;
+
+  public:
+    TagPickerField(const FieldBase &base) : IField(base) {}
+  };
+
   struct InvalidField : public FieldBase {};
 
   struct Separator {};

src/server/include/extend/tag-model.hpp

@@ -1,6 +1,7 @@
 #pragma once
 #include "extend/color-model.hpp"
 #include "extend/image-model.hpp"
+#include "lib/fuzzy/fuzzy-searchable.hpp"
 #include <qjsonobject.h>
 #include <qstring.h>
 
@@ -24,3 +25,19 @@ class TagListParser {
 
   TagListModel parse(const QJsonObject &instance);
 };
+
+struct TagPickerItemModel {
+  QString title;
+  QString value;
+  std::optional<ImageLikeModel> icon;
+
+public:
+  static TagPickerItemModel fromJson(const QJsonObject &instance);
+};
+
+template <> struct fuzzy::FuzzySearchable<TagPickerItemModel> {
+  static int score(const TagPickerItemModel &item, std::string_view query) {
+    auto name = item.title.toStdString();
+    return fuzzy::scoreWeighted({{name, 1.0}}, query);
+  }
+};

src/server/src/extend/form-model.cpp

@@ -3,9 +3,9 @@
 
 #include <algorithm>
 
-const static std::vector<QString> fieldTypes = {"dropdown-field",   "password-field",    "text-field",
-                                                "checkbox-field",   "date-picker-field", "text-area-field",
-                                                "file-picker-field"};
+const static std::vector<QString> fieldTypes = {"dropdown-field",    "password-field",    "text-field",
+                                                "checkbox-field",    "date-picker-field", "text-area-field",
+                                                "file-picker-field", "tag-picker-field"};
 
 FormModel FormModel::fromJson(const QJsonObject &json) {
   FormModel model;
@@ -123,6 +123,15 @@ FormModel FormModel::fromJson(const QJsonObject &json) {
           filePicker->showHiddenFiles = props.value("showHiddenFiles").toBool();
 
         model.items.emplace_back(filePicker);
+      } else if (*it == "tag-picker-field") {
+        auto tagPicker = std::make_shared<TagPickerField>(base);
+        tagPicker->m_items.reserve(children.size());
+
+        for (const auto &child : children) {
+          tagPicker->m_items.emplace_back(TagPickerItemModel::fromJson(child.toObject()));
+        }
+
+        model.items.emplace_back(tagPicker);
       }
     } else {
       qWarning() << "Unknown form children of type" << type;

src/server/src/extend/tag-list.cpp

@@ -1,8 +1,11 @@
 #include "extend/color-model.hpp"
 #include "extend/image-model.hpp"
 #include "extend/tag-model.hpp"
+#include <exception>
 #include <qjsonarray.h>
 #include <qjsonobject.h>
+#include <qlogging.h>
+#include <stdexcept>
 
 TagListParser::TagListParser() = default;
 
@@ -32,3 +35,15 @@ TagListModel TagListParser::parse(const QJsonObject &instance) {
 
   return model;
 }
+
+TagPickerItemModel TagPickerItemModel::fromJson(const QJsonObject &instance) {
+  TagPickerItemModel model;
+  auto props = instance.value("props").toObject();
+
+  model.title = props.value("title").toString();
+  model.value = props.value("value").toString();
+
+  if (props.contains("icon")) { model.icon = ImageModelParser().parse(props.value("icon")); }
+
+  return model;
+}

src/server/src/qml/extension-form-model.cpp

@@ -2,6 +2,9 @@
 #include "view-utils.hpp"
 #include <QJsonArray>
 #include <QJsonObject>
+#include <QJSValue>
+#include <qcontainerfwd.h>
+#include <qstringliteral.h>
 #include <utility>
 
 ExtensionFormModel::ExtensionFormModel(NotifyFn notify, QObject *parent)
@@ -54,7 +57,14 @@ void ExtensionFormModel::setFieldValue(int index, const QVariant &value) {
   auto &item = m_items[index];
   if (!item.isField()) return;
 
-  item.userValue = QJsonValue::fromVariant(value);
+  // TODO: find out why Form.TagPicker tags would break without that
+  QVariant normalizedValue = value;
+
+  if (value.metaType().id() == qMetaTypeId<QJSValue>()) {
+    normalizedValue = value.value<QJSValue>().toVariant();
+  }
+
+  item.userValue = QJsonValue::fromVariant(normalizedValue);
   item.hasUserValue = true;
   emit dataChanged(createIndex(index, 0), createIndex(index, 0), {ValueRole});
 
@@ -90,6 +100,23 @@ void ExtensionFormModel::setFilePaths(int index, const QVariantList &paths) {
   if (item.onChange) { m_notify(*item.onChange, QJsonArray{arr}); }
 }
 
+void ExtensionFormModel::setPickedItems(int index, const QVariantList &pickedItems) {
+  if (index < 0 || std::cmp_greater_equal(index, m_items.size())) return;
+  auto &item = m_items[index];
+  if (item.type != FormItemData::Type::TagPicker) return;
+
+  QJsonArray arr;
+  for (const auto &t : pickedItems) {
+    arr.append(t.toString());
+  }
+
+  item.userValue = arr;
+  item.hasUserValue = true;
+  emit dataChanged(createIndex(index, 0), createIndex(index, 0), {ValueRole});
+
+  if (item.onChange) { m_notify(*item.onChange, QJsonArray{arr}); }
+}
+
 void ExtensionFormModel::dropdownSearchTextChanged(int index, const QString &text) {
   if (index < 0 || std::cmp_greater_equal(index, m_items.size())) return;
   const auto &item = m_items[index];
@@ -187,10 +214,16 @@ ExtensionFormModel::FormItemData ExtensionFormModel::createItem(const FormModel:
     data.onFocus = field->onFocus;
     data.fieldData = buildFieldData(*field);
 
-    if (field->value) {
+    if (field->value && !(data.type == FormItemData::Type::TagPicker && field->value->isNull())) {
       data.modelValue = *field->value;
     } else if (field->defaultValue) {
       data.modelValue = *field->defaultValue;
+    } else if (data.type == FormItemData::Type::Dropdown) {
+      if (auto *df = dynamic_cast<const FormModel::DropdownField *>(field.get())) {
+        if (auto first = qml::firstDropdownItemValue(df->m_items)) { data.modelValue = *first; }
+      }
+    } else if (data.type == FormItemData::Type::TagPicker) {
+      data.modelValue = QJsonArray{};
     }
   } else if (auto *desc = std::get_if<FormModel::Description>(&item)) {
     data.type = FormItemData::Type::Description;
@@ -216,8 +249,11 @@ void ExtensionFormModel::updateItem(FormItemData &existing, const FormModel::Ite
     existing.fieldData = buildFieldData(*field);
 
     if (field->value) {
-      existing.modelValue = *field->value;
-      existing.hasUserValue = false;
+      bool const isNullTagValue = existing.type == FormItemData::Type::TagPicker && field->value->isNull();
+      if (!isNullTagValue) {
+        existing.modelValue = *field->value;
+        existing.hasUserValue = false;
+      }
     }
   } else if (auto *desc = std::get_if<FormModel::Description>(&newItem)) {
     existing.label = desc->title.value_or(QString());
@@ -233,6 +269,7 @@ ExtensionFormModel::FormItemData::Type ExtensionFormModel::fieldType(const FormM
   if (dynamic_cast<const FormModel::TextAreaField *>(&field)) return FormItemData::Type::TextArea;
   if (dynamic_cast<const FormModel::FilePickerField *>(&field)) return FormItemData::Type::FilePicker;
   if (dynamic_cast<const FormModel::DatePickerField *>(&field)) return FormItemData::Type::DatePicker;
+  if (dynamic_cast<const FormModel::TagPickerField *>(&field)) return FormItemData::Type::TagPicker;
   return FormItemData::Type::Text;
 }
 
@@ -257,6 +294,8 @@ QVariantMap ExtensionFormModel::buildFieldData(const FormModel::IField &field) {
     if (f->min) data["min"] = *f->min;
     if (f->max) data["max"] = *f->max;
     data["includeTime"] = f->type.value_or("date") == "dateTime";
+  } else if (auto *f = dynamic_cast<const FormModel::TagPickerField *>(&field)) {
+    data["items"] = qml::convertTagPickerItems(f->m_items);
   }
 
   return data;
@@ -282,6 +321,8 @@ QString ExtensionFormModel::FormItemData::typeString() const {
     return QStringLiteral("description");
   case Type::Separator:
     return QStringLiteral("separator");
+  case Type::TagPicker:
+    return QStringLiteral("tagpicker");
   }
   return QStringLiteral("text");
 }

src/server/src/qml/extension-form-model.hpp

@@ -5,6 +5,8 @@
 #include <QVariantMap>
 #include <expected>
 #include <functional>
+#include <qcontainerfwd.h>
+#include <qtmetamacros.h>
 #include <vector>
 
 class ExtensionFormModel : public QAbstractListModel {
@@ -38,6 +40,7 @@ class ExtensionFormModel : public QAbstractListModel {
   Q_INVOKABLE void fieldFocused(int index);
   Q_INVOKABLE void fieldBlurred(int index);
   Q_INVOKABLE void setFilePaths(int index, const QVariantList &paths);
+  Q_INVOKABLE void setPickedItems(int index, const QVariantList &pickedItems);
   Q_INVOKABLE void dropdownSearchTextChanged(int index, const QString &text);
 
   void setFormData(const FormModel &model);
@@ -53,6 +56,7 @@ class ExtensionFormModel : public QAbstractListModel {
       TextArea,
       FilePicker,
       DatePicker,
+      TagPicker,
       Description,
       Separator
     };