replica
/
hanchenye-llvm-project
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Cleaning up LLVM IR mode for Emacs. 

I've made a range of improvements to the Emacs mode for LLVM IR.

Most importantly, it changes llvm-mode to inherit from prog-mode. This
means llvm-mode will be treated as a normal programming mode in Emacs,
so many Emacs features will just work. prog-mode is new to Emacs 24,
so I've added an alias to ensure compatibility with Emacs 23 too.

I've changed the mode definition to use define-derived-mode. This
saves us needing to set up local variables ourselves, and saves us
needing to define llvm-mode-map, llvm-mode-abbrev-table,
llvm-mode-map.

I've removed the keybindings to tab-to-tab-stop, center-line and
center-paragraph. This shouldn't be llvm-mode's responsibility, and
the code didn't actually work anyway (since `(not llvm-mode-map)`
always evaluated to `t`, the keybindings were never executed).

I've simplified the syntax-table definition, it's equivalent (e.g. `"`
is treated as string delimiter by default in Emacs). I've added `.` as
a symbol constituent, so functions like `llvm.memset.p0i8.i32` are
recognised as a single symbol. I've also changed `%` to be a symbol
constituent, so users can move between words or symbols at their
choice, rather than conflating the two.

I've fixed regexp for types, which incorrect used `symbol` instead of
`symbols` as an argument to `regexp-opt`. This was causing incorrect
highlighting on lines like `call void @foovoid`.

I've removed string and comment highlighting from
`llvm-font-lock-keywords`. This is already handled by the
syntax-table.

Finally, I've removed the reference to jasmin. That project is long
abandoned and the link 404s. For reference, I've found an old copy of
the project here:
https://github.com/stevej/emacs/blob/master/vendor/jasmin/jasmin.el

Patch by Wilfred Hughes!

llvm-svn: 247281
This commit is contained in:
Rafael Espindola 2015-09-10 13:44:28 +00:00
parent 32ae76e7f9
commit 7915b9eb42
1 changed files with 19 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
llvm/utils/emacs/llvm-mode.el
View File

@ -8,22 +8,25 @@
;;; Code:
(defvar llvm-mode-syntax-table nil
(defvar llvm-mode-syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?% "_" table)
(modify-syntax-entry ?. "_" table)
(modify-syntax-entry ?\; "< " table)
(modify-syntax-entry ?\n "> " table)
table)
"Syntax table used while in LLVM mode.")
(defvar llvm-font-lock-keywords
(list
;; Comments
'(";.*" . font-lock-comment-face)
;; Variables
'("%[-a-zA-Z$\._][-a-zA-Z$\._0-9]*" . font-lock-variable-name-face)
;; Labels
'("[-a-zA-Z$\._0-9]+:" . font-lock-variable-name-face)
;; Strings
'("\"[^\"]+\"" . font-lock-string-face)
;; Unnamed variable slots
'("%[-]?[0-9]+" . font-lock-variable-name-face)
;; Types
`(,(regexp-opt '("void" "i1" "i8" "i16" "i32" "i64" "i128" "float" "double" "type" "label" "opaque") 'symbol) . font-lock-type-face)
`(,(regexp-opt '("void" "i1" "i8" "i16" "i32" "i64" "i128" "float" "double" "type" "label" "opaque") 'symbols) . font-lock-type-face)
;; Integer literals
'("\\b[-]?[0-9]+\\b" . font-lock-preprocessor-face)
;; Floating point constants
@ -56,84 +59,22 @@
;; Metadata types
`(,(regexp-opt '("distinct") 'symbols) . font-lock-keyword-face)
;; Use-list order directives
`(,(regexp-opt '("uselistorder" "uselistorder_bb") 'symbols) . font-lock-keyword-face)
`(,(regexp-opt '("uselistorder" "uselistorder_bb") 'symbols) . font-lock-keyword-face))
"Syntax highlighting for LLVM.")
)
"Syntax highlighting for LLVM."
)
;; ---------------------- Syntax table ---------------------------
;; Shamelessly ripped from jasmin.el
;; URL: http://www.neilvandyke.org/jasmin-emacs/jasmin.el.html
(if (not llvm-mode-syntax-table)
(progn
(setq llvm-mode-syntax-table (make-syntax-table))
(mapc (function (lambda (n)
(modify-syntax-entry (aref n 0)
(aref n 1)
llvm-mode-syntax-table)))
'(
;; whitespace (` ')
[?\^m " "]
[?\f " "]
[?\n " "]
[?\t " "]
[?\ " "]
;; word constituents (`w')
;;[?< "w"]
;;[?> "w"]
[?% "w"]
;;[?_ "w "]
;; comments
[?\; "< "]
[?\n "> "]
;;[?\r "> "]
;;[?\^m "> "]
;; symbol constituents (`_')
;; punctuation (`.')
;; open paren (`(')
;; close paren (`)')
;; string quote ('"')
[?\" "\""]))))
;; --------------------- Abbrev table -----------------------------
(defvar llvm-mode-abbrev-table nil
"Abbrev table used while in LLVM mode.")
(define-abbrev-table 'llvm-mode-abbrev-table ())
(defvar llvm-mode-hook nil)
(defvar llvm-mode-map nil) ; Create a mode-specific keymap.
(if (not llvm-mode-map)
() ; Do not change the keymap if it is already set up.
(setq llvm-mode-map (make-sparse-keymap))
(define-key llvm-mode-map "\t" 'tab-to-tab-stop)
(define-key llvm-mode-map "\es" 'center-line)
(define-key llvm-mode-map "\eS" 'center-paragraph))
;; Emacs 23 compatibility.
(defalias 'llvm-mode-prog-mode
(if (fboundp 'prog-mode)
'prog-mode
'fundamental-mode))
;;;###autoload
(defun llvm-mode ()
(define-derived-mode llvm-mode llvm-mode-prog-mode "LLVM"
"Major mode for editing LLVM source files.
\\{llvm-mode-map}
Runs `llvm-mode-hook' on startup."
(interactive)
(kill-all-local-variables)
(use-local-map llvm-mode-map) ; Provides the local keymap.
(setq major-mode 'llvm-mode)
(make-local-variable 'font-lock-defaults)
(setq major-mode 'llvm-mode ; This is how describe-mode
; finds the doc string to print.
mode-name "LLVM" ; This name goes into the modeline.
font-lock-defaults `(llvm-font-lock-keywords))
(setq local-abbrev-table llvm-mode-abbrev-table)
(set-syntax-table llvm-mode-syntax-table)
(setq comment-start ";")
(run-hooks 'llvm-mode-hook)) ; Finally, this permits the user to
; customize the mode with a hook.
(setq font-lock-defaults `(llvm-font-lock-keywords))
(setq comment-start ";"))
;; Associate .ll files with llvm-mode
;;;###autoload