[emacs] Add llvm-mir-mode
authorJustin Bogner <mail@justinbogner.com>
Tue, 7 Feb 2023 23:54:49 +0000 (15:54 -0800)
committerJustin Bogner <mail@justinbogner.com>
Wed, 8 Feb 2023 00:01:25 +0000 (16:01 -0800)
Adds an emacs mode for .mir files. For the most part this just
consists of keyword rules for various MIR constructs and then
appending the llvm-mode keywords to that. This doesn't currently
attempt to do anything to be aware of the YAML structure or
differentiate between machine IR and embedded LLVM IR.

llvm/utils/emacs/README
llvm/utils/emacs/llvm-mir-mode.el [new file with mode: 0644]

index d0f2bfb..44b5143 100644 (file)
@@ -12,6 +12,15 @@ are:
     (cons (expand-file-name "path-to-llvm/utils/emacs") load-path))
   (require 'llvm-mode)
   
+* llvm-mir-mode.el
+
+  Syntax highlighting mode for LLVM Machine IR files. To use, add this code to
+  your ~/.emacs :
+
+  (setq load-path
+    (cons (expand-file-name "path-to-llvm/utils/emacs") load-path))
+  (require 'llvm-mir-mode)
+
 * tablegen-mode.el
 
   Syntax highlighting mode for TableGen description files. To use, add this code
diff --git a/llvm/utils/emacs/llvm-mir-mode.el b/llvm/utils/emacs/llvm-mir-mode.el
new file mode 100644 (file)
index 0000000..6f1de42
--- /dev/null
@@ -0,0 +1,70 @@
+;;; llvm-mir-mode.el --- Major mode for LLVM Machine IR\r
+\r
+;; Maintainer:  The LLVM team, http://llvm.org/\r
+;; Version: 1.0\r
+\r
+;;; Commentary:\r
+\r
+;; Major mode for editing LLVM MIR files.\r
+\r
+;;; Code:\r
+\r
+(require 'llvm-mode)\r
+\r
+(defvar llvm-mir-mode-map\r
+  (let ((map (make-sparse-keymap)))\r
+    map)\r
+  "Keymap for `llvm-mir-mode'.")\r
+\r
+(defvar llvm-mir-mode-syntax-table\r
+  (let ((st (make-syntax-table)))\r
+    (modify-syntax-entry ?% "_" st)\r
+    (modify-syntax-entry ?$ "_" st)\r
+    (modify-syntax-entry ?. "_" st)\r
+    (modify-syntax-entry ?# "< " st)\r
+    (modify-syntax-entry ?\; "< " st)\r
+    (modify-syntax-entry ?\n "> " st)\r
+    st)\r
+  "Syntax table for `llvm-mir-mode'.")\r
+\r
+(defvar llvm-mir-font-lock-keywords\r
+  (append\r
+   (list\r
+    ; YAML Attributes\r
+    '("^name: +\\([a-zA-Z._][-a-zA-Z._0-9]*\\)"\r
+      1 font-lock-function-name-face)\r
+    '("^body: +|" . font-lock-keyword-face)\r
+    '("^[a-zA-Z_.][-a-zA-Z._0-9]*:" . font-lock-keyword-face)\r
+    `(,(regexp-opt '("true" "false")) . font-lock-constant-face)\r
+    ; YAML separators\r
+    '("^\\(---\\( |\\)?\\|\\.\\.\\.\\)$" . font-lock-comment-face)\r
+    ; Registers\r
+    '("%[a-zA-Z_.][-a-zA-Z._0-9]*" . font-lock-variable-name-face)\r
+    '("%[0-9]+\\(\\.[a-zA-Z._0-9]+\\)?" . font-lock-variable-name-face)\r
+    '("$[a-zA-Z_.][-a-zA-Z._0-9]*" . font-lock-constant-face)\r
+    ; Register classes\r
+    `(,(concat\r
+        "%\\([a-zA-Z_.][-a-zA-Z._0-9]*\\|[0-9]+\\(\\.[a-zA-Z._0-9]+\\)?\\)"\r
+        "\\(:[a-zA-Z_.][-a-zA-Z._0-9]*\\)")\r
+      3 font-lock-type-face)\r
+    '("class: \\([a-zA-Z_.][-a-zA-Z._0-9]*\\)" 1 font-lock-type-face)\r
+    ; MO Register flags\r
+    `(,(regexp-opt '("dead" "debug-use" "def" "early-clobber" "implicit"\r
+                     "implicit-def" "internal" "killed" "renamable" "undef")\r
+                   'symbols)\r
+      . font-lock-keyword-face))\r
+   llvm-font-lock-keywords)\r
+  "Keyword highlighting specification for `llvm-mir-mode'.")\r
+\r
+ ;;;###autoload\r
+(define-derived-mode llvm-mir-mode prog-mode "LLVM MIR"\r
+  "A major mode for editing LLVM MIR files."\r
+  (setq-local comment-start "; ")\r
+  (setq-local font-lock-defaults `(llvm-mir-font-lock-keywords)))\r
+\r
+;;;###autoload\r
+(add-to-list 'auto-mode-alist (cons "\\.mir\\'" 'llvm-mir-mode))\r
+\r
+(provide 'llvm-mir-mode)\r
+\r
+;;; llvm-mir-mode.el ends here\r