[lldb-vscode ]Add Syntax Highlighting to Disassembly View

[• aelitashen]

Summary

When lldb cannot find source file thus IDE renders a disassembly view, add syntax highlighting for constants, registers and final line comments for better debugging experience.
The original plain disassembly view looks like:

An ideal view is like the screenshot attached.

In this diff, the mimeType is a kind of media type for formatting the content in the response to a source request. Elements in the disassembly view, like constants, registers and final line comments are colored for highlighting.
A built-in support in the VSCode IDE for syntax highlighting will identify the which mimeType to apply and render the disassembly view as expected.

[wallace]

can you include a screenshot of how the view looked before (without the colors)?

Also explain that this is done via a mime-type identification and a built-in support in the IDE for syntax highlighting

Don't forget to use the new UUID I gave you

[• aelitashen]

Use unique id for disassembly.json

[wallace]

Very good!

[clayborg]

This seems very x86 centric. I forwarded a few examples of ARM and ARM64 disassembly to Yifan so we can improve some of the regexes.

[wallace]

It would be possible as well to have two media types with their corresponding syntax files, one for x86, and another for arm

[• aelitashen]

Cover ARM and ARM64 case in disassembly syntax highlighting

[wallace]

Move the sample files to the syntaxes folder.
Besides, the path /llvm/syntaxes/disassembly.json should just be syntaxes/disassembly.json. There's no need to have that llvm subfolder there

[• aelitashen]

Move everything to the right place

[clayborg]

Looks better. Can we test this?

[wallace]

I don't think there's any easy way to test this. I was reading the VSCode documentation and there's no nice test framework for this. So at this point I'm okay with it without test, as it's very easy to check that it works by visual inspection.

lldb/tools/lldb-vscode/lldb-vscode.cpp

void request_source(const llvm::json::Object &request) {
   auto source = arguments->getObject("source");
   auto sourceReference = GetSigned(source, "sourceReference", -1);
   auto pos = g_vsc.source_map.find((lldb::addr_t)sourceReference);
   if (pos != g_vsc.source_map.end()) {
     EmplaceSafeString(body, "content", pos->second.content);
   } else {
     response["success"] = llvm::json::Value(false);
   }
+  EmplaceSafeString(body, "mimeType", "text/x-lldb.disassembly");
   response.try_emplace("body", std::move(body));
   g_vsc.SendJSON(llvm::json::Value(std::move(response)));
 }
 
 // "StackTraceRequest": {
 //   "allOf": [ { "$ref": "#/definitions/Request" }, {
 //     "type": "object",
 //     "description": "StackTrace request; value of command field is

llvm/utils/vscode/llvm/package.json

"contributes": {
                     "LLVM IR",
                     "LLVM",
                     "llvm"
                 ],
                 "extensions": [
                     ".ll"
                 ],
                 "configuration": "./language-configuration.json"
+            },
+            {
+                "id": "lldb.disassembly",
+                "aliases": [
+                "Disassembly"
+                ],
+                "extensions": [
+                ".disasm"
+                ]
             }
         ],
         "grammars": [
             {
                 "language": "tablegen",
                 "scopeName": "source.tablegen",
                 "path": "./syntaxes/TableGen.tmLanguage"
             },
             {
                 "language": "llvm",
                 "scopeName": "source.llvm",
                 "path": "./syntaxes/ll.tmLanguage.json"
+            },
+            {
+                "language": "lldb.disassembly",
+                "scopeName": "source.disassembly",
+                "path": "./syntaxes/disassembly.json"
             }
         ],
         "taskDefinitions": [
             {
                 "type": "llvm-lit",
                 "required": [
                     "task"
                 ],
"devDependencies": {
         "typescript": "^3.8.3"
     },
     "extensionDependencies": ["ms-vscode.cmake-tools"],
     "scripts": {
         "vscode:prepublish": "npx js-yaml syntaxes/ll.tmLanguage.yaml > syntaxes/ll.tmLanguage.json && tsc -b",
         "watch": "tsc -b -w"
     }
 }
 No newline at end of file

llvm/utils/vscode/llvm/syntaxes/disassembly.json

+{
+  "name": "Disassembly",
+  "scopeName": "source.disassembly",
+  "uuid": "db74b3e8-fa2c-4b4e-b973-1ecc54d45ed0",
+  "patterns": [
+    {
+      "comment": "Address, bytes and opcode",
+      "name": "meta.instruction",
+      "match": "^([A-Za-z0-9]+):\\s([A-Z0-9]{2}\\s)+>?\\s+(\\w+)",
+      "captures": {
+        "1": {"name": "constant.numeric"},
+        "3": {"name": "keyword.opcode"}
+      }
+    },
+    {
+      "comment": "Numeric constant",
+      "name": "constant.numeric",
+      "match": "(\\$|\\b)((0x)|[0-9])[A-Za-z0-9]+\\b"
+    },
+    {
+      "comment": "Register",
+      "name": "variable.language",
+      "match": "%[A-Za-z][A-Za-z0-9]*"
+    },
+    {
+      "comment": "End of line comment",
+      "name": "comment.line.semicolon",
+      "match": ";.*$"
+    }
+  ]
+}