Initial control flow syntax highlighting implementation

Author: Sightem

gui/qt/datawidget.cpp

@@ -143,6 +143,9 @@ AsmHighlighter::AsmHighlighter(QTextDocument *parent) : QSyntaxHighlighter(paren
 
     mnemonicFormat.setForeground(QColor(darkMode ? "darkorange" : "darkblue"));
 
+    controlFlowFormat.setForeground(QColor("crimson"));
+    controlFlowTargetFormat.setForeground(QColor("#dc795d"));
+
     symbolFormat.setFontWeight(disasm.bold_sym ? QFont::DemiBold : QFont::Normal);
     rule.pattern = QRegularExpression("\\b\\w+\\b");
     rule.format = symbolFormat;
@@ -187,6 +190,14 @@ void AsmHighlighter::highlightBlock(const QString &text) {
         setFormat(match.capturedStart(4), match.capturedLength(4), breakPFormat);
         setFormat(match.capturedStart(5), match.capturedLength(5), bytesFormat);
         setFormat(match.capturedStart(6), match.capturedLength(6), mnemonicFormat);
+
+        const QString fullMnemonic = match.captured(6);
+        const QString primary = fullMnemonic.section('.', 0, 0).toUpper();
+        const bool isControlFlow = std::find(controlFlowMnemonics.begin(), controlFlowMnemonics.end(), primary) != controlFlowMnemonics.end();
+        if (isControlFlow) {
+            setFormat(match.capturedStart(6), match.capturedLength(6), controlFlowFormat);
+        }
+
         foreach(const HighlightingRule &rule, highlightingRules) {
             QRegularExpressionMatchIterator iter = rule.pattern.globalMatch(text, match.capturedEnd());
             while (iter.hasNext()) {
@@ -196,5 +207,45 @@ void AsmHighlighter::highlightBlock(const QString &text) {
                 }
             }
         }
+
+        if (!isControlFlow) {
+            return;
+        }
+
+        if (std::find(noTargetMnemonics.begin(), noTargetMnemonics.end(), primary) != noTargetMnemonics.end()) {
+            return;
+        }
+
+        const int operandStart = match.capturedEnd();
+        const QString operands = text.mid(operandStart);
+
+        // hex address patterns allowing optional +/ - after '$' for relative forms like $+5
+        const QRegularExpression hexTargetRe(QStringLiteral("\\$[+\\-]?[0-9A-Fa-f]+\\b"));
+        QRegularExpressionMatchIterator hIt = hexTargetRe.globalMatch(operands);
+        while (hIt.hasNext()) {
+            const auto m2 = hIt.next();
+            if (m2.hasMatch()) {
+                const int s = operandStart + m2.capturedStart();
+                const int l = m2.capturedLength();
+                setFormat(s, l, controlFlowTargetFormat);
+            }
+        }
+
+        // equate/label tokens (exclude registers and condition codes)
+        const QRegularExpression labelRe(QStringLiteral("\\b[._A-Za-z][._A-Za-z0-9]*\\b"));
+
+        QRegularExpressionMatchIterator lIt = labelRe.globalMatch(operands);
+        while (lIt.hasNext()) {
+            const auto m3 = lIt.next();
+            if (m3.hasMatch()) {
+                const QString tok = m3.captured().toUpper();
+                if (std::find(reservedTokens.begin(), reservedTokens.end(), tok) != reservedTokens.end()) {
+                    continue;
+                }
+                const int start = operandStart + m3.capturedStart();
+                const int len = m3.capturedLength();
+                setFormat(start, len, controlFlowTargetFormat);
+            }
+        }
     }
 }

gui/qt/datawidget.h

@@ -6,6 +6,7 @@
 #include <QtGui/QTextCharFormat>
 #include <QtCore/QRegularExpression>
 #include <QtCore/QObject>
+#include <QtCore/QStringList>
 
 QT_BEGIN_NAMESPACE
     class QPaintEvent;
@@ -39,11 +40,39 @@ class AsmHighlighter : public QSyntaxHighlighter
     QTextCharFormat breakPFormat;
     QTextCharFormat bytesFormat;
     QTextCharFormat mnemonicFormat;
+    QTextCharFormat controlFlowFormat;
+    QTextCharFormat controlFlowTargetFormat;
     QTextCharFormat hexFormat;
     QTextCharFormat decimalFormat;
     QTextCharFormat parenFormat;
     QTextCharFormat registerFormat;
 
+    std::array<std::string_view, 8> controlFlowMnemonics {
+        "CALL",
+        "DJNZ",
+        "JP",
+        "JR",
+        "RET",
+        "RETI",
+        "RETN",
+        "RST"
+    };
+
+    std::array<std::string_view, 3> noTargetMnemonics {
+        "RET",
+        "RETI",
+        "RETN"
+    };
+
+    std::array<std::string_view, 29> reservedTokens {
+        "A", "B", "C", "D", "E", "H", "L", "I", "R",
+        "AF", "BC", "DE", "HL", "SP",
+        "IX", "IY", "IXH", "IXL",
+        "IYH", "IYL", "MB",
+        "NZ", "Z", "NC", "C",
+        "PO", "PE", "P", "M"
+    };
+
     QRegularExpression labelPattern;
     QRegularExpression instructionPattern;
 };