From 0b75031ac5e16a8deb8fd1c22b2879bd9046d131 Mon Sep 17 00:00:00 2001
From: Dmytro Maluka <dmitrymaluka@gmail.com>
Date: Sat, 15 Mar 2025 14:29:45 +0100
Subject: [PATCH] syntax: asm: highlight C-like comments (#3696)

Different assemblers have different syntaxes for comments: ";", "#",
"!", "|", "@", "*" and finally C-like comments "//" and "/* ... */".

Micro currently highlights only ";". This is causing various problems
with broken highlighting with other types of comments (i.e. those not
recognized by micro as comments), when the text in those comments
contains special characters, causing wrong highlighting of text after
them.

On the other hand, highlighting comments like "#", "|" etc would cause
conflicts with other syntax elements, e.g. constants in ARM assembly,
preprocessor directives, arithmetic expressions etc.

So let's highlight at least C-like comments. They are quite commonly
used and they are not so likely to cause conflicts with other syntax
elements.
---
 runtime/syntax/asm.yaml | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/runtime/syntax/asm.yaml b/runtime/syntax/asm.yaml
index f8f4c12c..2c463257 100644
--- a/runtime/syntax/asm.yaml
+++ b/runtime/syntax/asm.yaml
@@ -4,7 +4,7 @@ detect:
     filename: "\\.(S|s|asm)$"
 
 rules:
-    # This file is made for NASM assembly
+    # This file is made mainly for NASM assembly
 
     ## Instructions
     # x86
@@ -108,3 +108,16 @@ rules:
         rules:
             - todo: "(TODO|XXX|FIXME):?"
 
+    ## C-like comments (supported by some assemblers)
+
+    - comment:
+        start: "//"
+        end: "$"
+        rules:
+            - todo: "(TODO|XXX|FIXME):?"
+
+    - comment:
+        start: "/\\*"
+        end: "\\*/"
+        rules:
+            - todo: "(TODO|XXX|FIXME):?"