• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1;;; llvm-mode.el --- Major mode for the LLVM assembler language.
2
3;; Maintainer:  The LLVM team, http://llvm.org/
4
5;;; Commentary:
6
7;; Major mode for editing LLVM IR files.
8
9;;; Code:
10
11(defvar llvm-mode-syntax-table nil
12  "Syntax table used while in LLVM mode.")
13(defvar llvm-font-lock-keywords
14  (list
15   ;; Comments
16   '(";.*" . font-lock-comment-face)
17   ;; Variables
18   '("%[-a-zA-Z$\._][-a-zA-Z$\._0-9]*" . font-lock-variable-name-face)
19   ;; Labels
20   '("[-a-zA-Z$\._0-9]+:" . font-lock-variable-name-face)
21   ;; Strings
22   '("\"[^\"]+\"" . font-lock-string-face)
23   ;; Unnamed variable slots
24   '("%[-]?[0-9]+" . font-lock-variable-name-face)
25   ;; Types
26   `(,(regexp-opt '("void" "i1" "i8" "i16" "i32" "i64" "i128" "float" "double" "type" "label" "opaque") 'symbol) . font-lock-type-face)
27   ;; Integer literals
28   '("\\b[-]?[0-9]+\\b" . font-lock-preprocessor-face)
29   ;; Floating point constants
30   '("\\b[-+]?[0-9]+\.[0-9]*\([eE][-+]?[0-9]+\)?\\b" . font-lock-preprocessor-face)
31   ;; Hex constants
32   '("\\b0x[0-9A-Fa-f]+\\b" . font-lock-preprocessor-face)
33   ;; Keywords
34   `(,(regexp-opt '("begin" "end" "true" "false" "zeroinitializer" "declare"
35                    "define" "global" "constant" "const" "internal" "linkonce" "linkonce_odr"
36                    "weak" "weak_odr" "appending" "uninitialized" "implementation" "..."
37                    "null" "undef" "to" "except" "not" "target" "endian" "little" "big"
38                    "pointersize" "volatile" "fastcc" "coldcc" "cc" "personality") 'symbols) . font-lock-keyword-face)
39   ;; Arithmetic and Logical Operators
40   `(,(regexp-opt '("add" "sub" "mul" "sdiv" "udiv" "urem" "srem" "and" "or" "xor"
41                    "setne" "seteq" "setlt" "setgt" "setle" "setge") 'symbols) . font-lock-keyword-face)
42   ;; Floating-point operators
43   `(,(regexp-opt '("fadd" "fsub" "fmul" "fdiv" "frem") 'symbols) . font-lock-keyword-face)
44   ;; Special instructions
45   `(,(regexp-opt '("phi" "tail" "call" "select" "to" "shl" "lshr" "ashr" "fcmp" "icmp" "va_arg" "landingpad") 'symbols) . font-lock-keyword-face)
46   ;; Control instructions
47   `(,(regexp-opt '("ret" "br" "switch" "invoke" "resume" "unwind" "unreachable" "indirectbr") 'symbols) . font-lock-keyword-face)
48   ;; Memory operators
49   `(,(regexp-opt '("malloc" "alloca" "free" "load" "store" "getelementptr" "fence" "cmpxchg" "atomicrmw") 'symbols) . font-lock-keyword-face)
50   ;; Casts
51   `(,(regexp-opt '("bitcast" "inttoptr" "ptrtoint" "trunc" "zext" "sext" "fptrunc" "fpext" "fptoui" "fptosi" "uitofp" "sitofp" "addrspacecast") 'symbols) . font-lock-keyword-face)
52   ;; Vector ops
53   `(,(regexp-opt '("extractelement" "insertelement" "shufflevector") 'symbols) . font-lock-keyword-face)
54   ;; Aggregate ops
55   `(,(regexp-opt '("extractvalue" "insertvalue") 'symbols) . font-lock-keyword-face)
56   ;; Metadata types
57   `(,(regexp-opt '("distinct") 'symbols) . font-lock-keyword-face)
58   ;; Use-list order directives
59   `(,(regexp-opt '("uselistorder" "uselistorder_bb") 'symbols) . font-lock-keyword-face)
60
61   )
62  "Syntax highlighting for LLVM."
63  )
64
65;; ---------------------- Syntax table ---------------------------
66;; Shamelessly ripped from jasmin.el
67;; URL: http://www.neilvandyke.org/jasmin-emacs/jasmin.el.html
68
69(if (not llvm-mode-syntax-table)
70    (progn
71      (setq llvm-mode-syntax-table (make-syntax-table))
72      (mapc (function (lambda (n)
73                        (modify-syntax-entry (aref n 0)
74                                             (aref n 1)
75                                             llvm-mode-syntax-table)))
76            '(
77              ;; whitespace (` ')
78              [?\^m " "]
79              [?\f  " "]
80              [?\n  " "]
81              [?\t  " "]
82              [?\   " "]
83              ;; word constituents (`w')
84              ;;[?<  "w"]
85              ;;[?>  "w"]
86              [?%  "w"]
87              ;;[?_  "w  "]
88              ;; comments
89              [?\;  "< "]
90              [?\n  "> "]
91              ;;[?\r  "> "]
92              ;;[?\^m "> "]
93              ;; symbol constituents (`_')
94              ;; punctuation (`.')
95              ;; open paren (`(')
96              ;; close paren (`)')
97              ;; string quote ('"')
98              [?\" "\""]))))
99
100;; --------------------- Abbrev table -----------------------------
101
102(defvar llvm-mode-abbrev-table nil
103  "Abbrev table used while in LLVM mode.")
104(define-abbrev-table 'llvm-mode-abbrev-table ())
105
106(defvar llvm-mode-hook nil)
107(defvar llvm-mode-map nil)   ; Create a mode-specific keymap.
108
109(if (not llvm-mode-map)
110    ()  ; Do not change the keymap if it is already set up.
111  (setq llvm-mode-map (make-sparse-keymap))
112  (define-key llvm-mode-map "\t" 'tab-to-tab-stop)
113  (define-key llvm-mode-map "\es" 'center-line)
114  (define-key llvm-mode-map "\eS" 'center-paragraph))
115
116;;;###autoload
117(defun llvm-mode ()
118  "Major mode for editing LLVM source files.
119\\{llvm-mode-map}
120  Runs `llvm-mode-hook' on startup."
121  (interactive)
122  (kill-all-local-variables)
123  (use-local-map llvm-mode-map)         ; Provides the local keymap.
124  (setq major-mode 'llvm-mode)
125
126  (make-local-variable 'font-lock-defaults)
127  (setq major-mode 'llvm-mode           ; This is how describe-mode
128                                        ;   finds the doc string to print.
129  mode-name "LLVM"                      ; This name goes into the modeline.
130  font-lock-defaults `(llvm-font-lock-keywords))
131
132  (setq local-abbrev-table llvm-mode-abbrev-table)
133  (set-syntax-table llvm-mode-syntax-table)
134  (setq comment-start ";")
135  (run-hooks 'llvm-mode-hook))          ; Finally, this permits the user to
136                                        ;   customize the mode with a hook.
137
138;; Associate .ll files with llvm-mode
139;;;###autoload
140(add-to-list 'auto-mode-alist (cons (purecopy "\\.ll\\'")  'llvm-mode))
141
142(provide 'llvm-mode)
143
144;;; llvm-mode.el ends here
145