src/anki: make memento glossaries track closer to yomitan's

Yomitan has expanded structured content quite a bit. This commit bring's
Memento's structured content parser up to parity with Yomitan's by
adding support to styles.css files which are now in DictionaryInfos and
all the new fields supported by structured content.

This moves away from using inline styles and instead adds a default
stylesheet.

Author: ripose-jp

src/anki/glossarybuilder.cpp

@@ -20,10 +20,12 @@
 
 #pragma once
 
-#include <QString>
-#include <QPair>
-#include <QList>
 #include <QJsonArray>
+#include <QJsonObject>
+#include <QList>
+#include <QPair>
+#include <QSet>
+#include <QString>
 
 /**
  * @brief Builds Anki-compatible glossaries.
@@ -60,6 +62,33 @@ class GlossaryBuilder
 private:
     GlossaryBuilder() {}
 
+    /**
+     * @brief Escape a string for use in HTML.
+     *
+     * @param str The string to escape.
+     * @return An HTML escaped string.
+     */
+    [[nodiscard]]
+    static QString escapeHtml(const QString &str);
+
+    /**
+     * @brief Convert a structured data key to an HTML data attribute name.
+     *
+     * @param key The structured data key.
+     * @return The HTML data attribute name.
+     */
+    [[nodiscard]]
+    static QString structuredDataAttributeName(const QString &key);
+
+    /**
+     * @brief Check if a structured content tag is supported.
+     *
+     * @param tag The structured content tag to check.
+     * @return true if the tag is supported, false otherwise.
+     */
+    [[nodiscard]]
+    static bool isSupportedStructuredTag(const QString &tag);
+
     /**
      * @brief Add structured data attributes to the string.
      *

src/anki/glossarybuilder.h

@@ -24,6 +24,7 @@
 
 #include <QDir>
 #include <QHash>
+#include <QSet>
 
 #include "anki/ankiconnect.h"
 #include "anki/marker.h"
@@ -536,6 +537,10 @@ static std::optional<AudioMediaParams> getAudioMediaParams(
     {
         std::optional<TimingSource> source =
             getTimingSource(marker.args[SOURCE_KEY]);
+        if (!source)
+        {
+            return {};
+        }
         params.source = *source;
     }
 
@@ -629,6 +634,10 @@ static std::optional<VideoParams> getVideoParams(
     {
         std::optional<TimingSource> source =
             getTimingSource(marker.args[SOURCE_KEY]);
+        if (!source)
+        {
+            return {};
+        }
         params.source = *source;
     }
 
@@ -1099,31 +1108,71 @@ static int getFrequencyAverage(const QList<Frequency *> &frequencies)
 [[nodiscard]]
 static GlossaryData getGlossary(const QList<TermDefinition *> &definitions)
 {
+    constexpr const char *GLOSSARY_OPEN =
+        "<div class=\"yomitan-glossary memento-glossary\">"
+            "<ol>";
+    constexpr const char *GLOSSARY_CLOSE =
+        "<style>"
+            ".memento-glossary {"
+                "text-align: left;"
+            "}"
+
+            ".memento-glossary img {"
+                "display: inline-block;"
+            "}"
+
+            ".memento-glossary table {"
+                "table-layout: auto;"
+                "border-collapse: collapse;"
+            "}"
+
+            ".memento-glossary th {"
+                "font-weight: bold;"
+                "border-style: solid;"
+                "padding: 0.25em;"
+                "vertical-align: top;"
+                "border-width: 1px;"
+                "border-color: currentColor;"
+            "}"
+
+            ".memento-glossary td {"
+                "border-style: solid;"
+                "padding: 0.25em;"
+                "vertical-align: top;"
+                "border-width: 1px;"
+                "border-color: currentColor;"
+            "}"
+        "</style></ol></div>";
+    static const QString LIST_ITEM_DICTIONARY = "<li data-dictionary=\"%1\">";
+
     if (definitions.empty())
     {
         return {};
     }
 
     GlossaryData data;
+    QSet<int64_t> dictionariesWithStyles;
 
     QString basepath =
         DirectoryUtils::getDictionaryResourceDir() + QDir::separator();
 
-    data.glossary += "<div style=\"text-align: left;\"><ol>";
-    data.glossaryBrief += "<div style=\"text-align: left;\"><ol>";
-    data.glossaryCompact += "<div style=\"text-align: left;\"><ol>";
+    data.glossary += GLOSSARY_OPEN;
+    data.glossaryBrief += GLOSSARY_OPEN;
+    data.glossaryCompact += GLOSSARY_OPEN;
 
-    for (const TermDefinition *def : definitions)
+    for (qsizetype i = 0; i < definitions.size(); ++i)
     {
+        const TermDefinition *def = definitions[i];
+
         if (!def->selected())
         {
             continue;
         }
 
         data.glossary +=
-            "<li data-dictionary=\"" + def->dictionaryInfo()->name() + "\">";
+            LIST_ITEM_DICTIONARY.arg(def->dictionaryInfo()->name());
         data.glossaryCompact +=
-            "<li data-dictionary=\"" + def->dictionaryInfo()->name() + "\">";
+            LIST_ITEM_DICTIONARY.arg(def->dictionaryInfo()->name());
 
         data.glossary += "<i>(";
         data.glossaryCompact += "<i>(";
@@ -1137,7 +1186,7 @@ static GlossaryData getGlossary(const QList<TermDefinition *> &definitions)
         data.glossaryCompact += def->dictionaryInfo()->name();
         data.glossaryCompact += ")</i> ";
 
-        data.glossary += "<span><ul>";
+        data.glossary += "<span>";
         data.glossaryCompact += "<span>";
 
         QStringList items = GlossaryBuilder::buildGlossary(
@@ -1147,23 +1196,39 @@ static GlossaryData getGlossary(const QList<TermDefinition *> &definitions)
         );
         for (const QString &item : items)
         {
-            data.glossary += "<li>";
             data.glossary += item;
-            data.glossary += "</li>";
 
             data.glossaryBrief += "<li>";
             data.glossaryBrief += item;
             data.glossaryBrief += "</li>";
         }
         data.glossaryCompact += items.join(" | ");
 
-        data.glossary += "</ul></span></li>";
+        data.glossary += "</span></li>";
         data.glossaryCompact += "</span></li>";
+
+        if (!def->dictionaryInfo()->styles().isEmpty() &&
+            !dictionariesWithStyles.contains(def->dictionaryInfo()->id()))
+        {
+            dictionariesWithStyles.insert(def->dictionaryInfo()->id());
+
+            data.glossary += "<style>";
+            data.glossary += def->dictionaryInfo()->styles();
+            data.glossary += "</style>";
+
+            data.glossaryBrief += "<style>";
+            data.glossaryBrief += def->dictionaryInfo()->styles();
+            data.glossaryBrief += "</style>";
+
+            data.glossaryCompact += "<style>";
+            data.glossaryCompact += def->dictionaryInfo()->styles();
+            data.glossaryCompact += "</style>";
+        }
     }
 
-    data.glossary += "</ol></div>";
-    data.glossaryBrief += "</ol></div>";
-    data.glossaryCompact += "</ol></div>";
+    data.glossary += GLOSSARY_CLOSE;
+    data.glossaryBrief += GLOSSARY_CLOSE;
+    data.glossaryCompact += GLOSSARY_CLOSE;
     return data;
 }
 

src/anki/notebuilder.cpp

@@ -36,6 +36,7 @@ DictionaryInfo *DictionaryInfo::clone(QObject *parent) const
     copy->setId(id());
     copy->setName(name());
     copy->setEnabled(enabled());
+    copy->setStyles(styles());
     return copy;
 }
 
@@ -83,3 +84,18 @@ void DictionaryInfo::setEnabled(bool value)
     m_enabled = value;
     emit enabledChanged(m_enabled);
 }
+
+const QString &DictionaryInfo::styles() const noexcept
+{
+    return m_styles;
+}
+
+void DictionaryInfo::setStyles(const QString &value)
+{
+    if (m_styles == value)
+    {
+        return;
+    }
+    m_styles = value;
+    emit stylesChanged(m_styles);
+}

src/dict/data/dictionaryinfo.cpp

@@ -52,52 +52,59 @@ class DictionaryInfo : public QObject
         NOTIFY enabledChanged
     )
 
+    Q_PROPERTY(
+        QString styles
+        READ styles
+        WRITE setStyles
+        NOTIFY stylesChanged
+    )
+
     friend class DictionarySearch;
 
 public:
     DictionaryInfo(QObject *parent = nullptr);
     virtual ~DictionaryInfo();
 
     /**
-     * @brief Creates a deep copy of this object.
+     * @brief Create a deep copy of this object.
      *
      * @param parent The parent of the new object.
      * @return The cloned DictionaryInfo.
      */
     DictionaryInfo *clone(QObject *parent = nullptr) const;
 
     /**
-     * @brief Gets the ID of the dictionary.
+     * @brief Get the ID of the dictionary.
      *
      * @return The dictionary id.
      */
     [[nodiscard]]
     int64_t id() const noexcept;
 
     /**
-     * @brief Sets the ID of the dictionary.
+     * @brief Set the ID of the dictionary.
      *
      * @param value The new ID of the dictionary.
      */
     void setId(int64_t value);
 
     /**
-     * @brief Gets the name of the dictionary.
+     * @brief Get the name of the dictionary.
      *
      * @return The name of the dictionary.
      */
     [[nodiscard]]
     const QString &name() const noexcept;
 
     /**
-     * @brief Sets the name of the dictionary.
+     * @brief Set the name of the dictionary.
      *
      * @param value The new name of the dictionary.
      */
     void setName(const QString &value);
 
     /**
-     * @brief Gets if the dictionary is enabled.
+     * @brief Get if the dictionary is enabled.
      *
      * @return true if the dictionary is enabled,
      * @return false otherwise.
@@ -106,12 +113,27 @@ class DictionaryInfo : public QObject
     bool enabled() const noexcept;
 
     /**
-     * @brief Sets if the dictionary is enabled.
+     * @brief Set if the dictionary is enabled.
      *
      * @param value true if the dictionary should be enabled, false otherwise.
      */
     void setEnabled(bool value);
 
+    /**
+     * @brief Get the CSS stylesheet for this dictionary.
+     *
+     * @return The CSS stylesheet for this dictionary.
+     */
+    [[nodiscard]]
+    const QString &styles() const noexcept;
+
+    /**
+     * @brief Set the CSS stylesheet for this dictionary.
+     *
+     * @param value The CSS stylesheet for this dictionary.
+     */
+    void setStyles(const QString &value);
+
 signals:
     /**
      * @brief Emitted when the ID of the dictionary changes.
@@ -134,6 +156,13 @@ class DictionaryInfo : public QObject
      */
     void enabledChanged(bool value);
 
+    /**
+     * @brief Emitted when the CSS stylesheet is changed.
+     *
+     * @param value The new stylesheet.
+     */
+    void stylesChanged(const QString &value);
+
 protected:
     /* ID of the dictionary */
     int64_t m_id{0};
@@ -143,4 +172,7 @@ class DictionaryInfo : public QObject
 
     /* true if this dictionary is enabled, false otherwise */
     bool m_enabled{false};
+
+    /* The CSS stylesheet of this dictionary */
+    QString m_styles;
 };