pbek/QOwnNotes#3222: Merge pull request #214 from DarienMC/feature/gd…

…script_highlighting Add GDScript Language Data for Markdown Highlighting.
pbek · Feb 1, 2025 · 1933a6d · 1933a6d
2 parents 4864cb2 + 363c27c
commit 1933a6d
Show file tree

Hide file tree

Showing 4 changed files with 1,294 additions and 2 deletions.
diff --git a/markdownhighlighter.cpp b/markdownhighlighter.cpp
@@ -374,7 +374,9 @@ void MarkdownHighlighter::initCodeLangs() {
             {QLatin1String("yaml"), MarkdownHighlighter::CodeYAML},
             {QLatin1String("forth"), MarkdownHighlighter::CodeForth},
             {QLatin1String("systemverilog"),
-             MarkdownHighlighter::CodeSystemVerilog}};
+             MarkdownHighlighter::CodeSystemVerilog},
+            {QLatin1String("gdscript"), MarkdownHighlighter::CodeGDScript},
+    };
 }
 
 /**
@@ -768,6 +770,7 @@ void MarkdownHighlighter::highlightSyntax(const QString &text) {
     bool isYAML = false;
     bool isMake = false;
     bool isForth = false;
+    bool isGDScript = false;
 
     QMultiHash<char, QLatin1String> keywords{};
     QMultiHash<char, QLatin1String> others{};
@@ -921,6 +924,12 @@ void MarkdownHighlighter::highlightSyntax(const QString &text) {
         case HighlighterState::CodeSystemVerilogComment:
             loadSystemVerilogData(types, keywords, builtin, literals, others);
             break;
+        case HighlighterState::CodeGDScript:
+        case HighlighterState::CodeGDScript + tildeOffset:
+            isGDScript = true;
+            loadGDScriptData(types, keywords, builtin, literals, others);
+            comment = QLatin1Char('#');
+            break;
         default:
             setFormat(0, textLen, _formats[CodeBlock]);
             return;
@@ -1082,6 +1091,7 @@ void MarkdownHighlighter::highlightSyntax(const QString &text) {
     if (isYAML) ymlHighlighter(text);
     if (isMake) makeHighlighter(text);
     if (isForth) forthHighlighter(text);
+    if (isGDScript) gdscriptHighlighter(text);
 }
 
 /**
@@ -1696,6 +1706,36 @@ void MarkdownHighlighter::forthHighlighter(const QString &text) {
     }
 }
 
+/**
+ * @brief The GDScript highlighter
+ * @param text
+ * @details This function is responsible for GDScript highlighting.
+ * 1. Hightlight '$' NodePath constructs.
+ * 2. Highlight '%' UniqueNode constructs.
+ * 3. Highlight '@' annotations as `CodeOther`
+ */
+void MarkdownHighlighter::gdscriptHighlighter(const QString &text) {
+    if (text.isEmpty()) return;
+    const auto textLen = text.length();
+
+    for (int i = 0; i < textLen; ++i) {
+        // 1. Hightlight '$' NodePath constructs.
+        if (i + 1 <= textLen && text[i] == QLatin1Char('$')) {
+            /* TODO: Hightlight '$' NodePath constructs */
+            setFormat(i, 1, _formats[CodeNumLiteral]);
+        }
+        // 2. Highlight '%' UniqueNode constructs.
+        else if (i + 1 <= textLen && text[i] == QLatin1Char('%')) {
+            /* TODO: Highlight '%' UniqueNode constructs */
+            setFormat(i, 1, _formats[CodeNumLiteral]);
+        }
+        // 3. Hightlight '@' annotations symbol
+        else if (i + 1 <= textLen && text[i] == QLatin1Char('@')) {
+            setFormat(i, 1, _formats[CodeOther]);
+        }
+    }
+}
+
 /**
  * Highlight multi-line frontmatter blocks
  *

diff --git a/markdownhighlighter.h b/markdownhighlighter.h
@@ -213,6 +213,7 @@ class MarkdownHighlighter : public QSyntaxHighlighter {
         CodeForthComment = 249,
         CodeSystemVerilog = 250,
         CodeSystemVerilogComment = 251,
+        CodeGDScript = 252,
     };
     Q_ENUM(HighlighterState)
 
@@ -331,9 +332,10 @@ class MarkdownHighlighter : public QSyntaxHighlighter {
     void makeHighlighter(const QString &text);
 
     void forthHighlighter(const QString &text);
-
     void taggerScriptHighlighter(const QString &text);
 
+    void gdscriptHighlighter(const QString &text);
+
     void addDirtyBlock(const QTextBlock &block);
 
     void reHighlightDirtyBlocks();