xref: /llvm-project/llvm/utils/emacs/tablegen-mode.el (revision 5b4abae7630572c96a736faa1f09b1a3c37201a2)
1;;; tablegen-mode.el --- Major mode for TableGen description files (part of LLVM project)
2
3;; Maintainer:  The LLVM team, http://llvm.org/
4;; Version: 1.0
5
6;;; Commentary:
7;; A major mode for TableGen description files in LLVM.
8
9(require 'comint)
10(require 'custom)
11(require 'ansi-color)
12
13;; Create mode-specific tables.
14;;; Code:
15
16(defvar td-decorators-face 'td-decorators-face
17  "Face method decorators.")
18(make-face 'td-decorators-face)
19
20(defvar tablegen-font-lock-keywords
21  (let ((kw (regexp-opt '("class" "defm" "def" "field" "include" "in"
22                         "let" "multiclass" "foreach" "if" "then" "else"
23                         "defvar" "defset" "dump" "assert")
24                        'words))
25        (type-kw (regexp-opt '("bit" "bits" "code" "dag" "int" "list" "string")
26                             'words))
27        )
28    (list
29     ;; Comments
30;;     '("\/\/" . font-lock-comment-face)
31     ;; Strings
32     '("\"[^\"]+\"" . font-lock-string-face)
33     ;; Hex constants
34     '("\\<0x[0-9A-Fa-f]+\\>" . font-lock-preprocessor-face)
35     ;; Binary constants
36     '("\\<0b[01]+\\>" . font-lock-preprocessor-face)
37     ;; Integer literals
38     '("\\<[-]?[0-9]+\\>" . font-lock-preprocessor-face)
39     ;; Floating point constants
40     '("\\<[-+]?[0-9]+\.[0-9]*\([eE][-+]?[0-9]+\)?\\>" . font-lock-preprocessor-face)
41
42     '("^[ \t]*\\(@.+\\)" 1 'td-decorators-face)
43     ;; Keywords
44     kw
45     ;; Type keywords
46     type-kw
47     ))
48  "Additional expressions to highlight in TableGen mode.")
49(put 'tablegen-mode 'font-lock-defaults '(tablegen-font-lock-keywords))
50
51;; ---------------------- Syntax table ---------------------------
52
53(defvar tablegen-mode-syntax-table nil
54  "Syntax table used in `tablegen-mode' buffers.")
55(when (not tablegen-mode-syntax-table)
56  (setq tablegen-mode-syntax-table (make-syntax-table))
57  ;; whitespace (` ')
58  (modify-syntax-entry ?\   " "      tablegen-mode-syntax-table)
59  (modify-syntax-entry ?\t  " "      tablegen-mode-syntax-table)
60  (modify-syntax-entry ?\r  " "      tablegen-mode-syntax-table)
61  (modify-syntax-entry ?\n  " "      tablegen-mode-syntax-table)
62  (modify-syntax-entry ?\f  " "      tablegen-mode-syntax-table)
63  ;; word constituents (`w')
64  (modify-syntax-entry ?\%  "w"      tablegen-mode-syntax-table)
65  (modify-syntax-entry ?\_  "w"      tablegen-mode-syntax-table)
66  ;; comments
67  (modify-syntax-entry ?/   ". 124b" tablegen-mode-syntax-table)
68  (modify-syntax-entry ?*   ". 23"   tablegen-mode-syntax-table)
69  (modify-syntax-entry ?\n  "> b"    tablegen-mode-syntax-table)
70  ;; open paren (`(')
71  (modify-syntax-entry ?\(  "("      tablegen-mode-syntax-table)
72  (modify-syntax-entry ?\[  "("      tablegen-mode-syntax-table)
73  (modify-syntax-entry ?\{  "("      tablegen-mode-syntax-table)
74  (modify-syntax-entry ?\<  "("      tablegen-mode-syntax-table)
75  ;; close paren (`)')
76  (modify-syntax-entry ?\)  ")"      tablegen-mode-syntax-table)
77  (modify-syntax-entry ?\]  ")"      tablegen-mode-syntax-table)
78  (modify-syntax-entry ?\}  ")"      tablegen-mode-syntax-table)
79  (modify-syntax-entry ?\>  ")"      tablegen-mode-syntax-table)
80  ;; string quote ('"')
81  (modify-syntax-entry ?\"  "\""     tablegen-mode-syntax-table)
82  )
83
84;; --------------------- Abbrev table -----------------------------
85
86(defvar tablegen-mode-abbrev-table nil
87  "Abbrev table used while in TableGen mode.")
88(define-abbrev-table 'tablegen-mode-abbrev-table ())
89
90(defvar tablegen-mode-hook nil)
91(defvar tablegen-mode-map nil)   ; Create a mode-specific keymap.
92
93(if (not tablegen-mode-map)
94    ()  ; Do not change the keymap if it is already set up.
95  (setq tablegen-mode-map (make-sparse-keymap))
96  (define-key tablegen-mode-map "\t"  'tab-to-tab-stop)
97  (define-key tablegen-mode-map "\es" 'center-line)
98  (define-key tablegen-mode-map "\eS" 'center-paragraph))
99
100;;;###autoload
101(defun tablegen-mode ()
102  "Major mode for editing TableGen description files.
103\\{tablegen-mode-map}
104  Runs `tablegen-mode-hook' on startup."
105  (interactive)
106  (kill-all-local-variables)
107  (use-local-map tablegen-mode-map)      ; Provides the local keymap.
108  (make-local-variable 'font-lock-defaults)
109  (setq major-mode 'tablegen-mode        ; This is how describe-mode
110                                         ;   finds the doc string to print.
111	mode-name             "TableGen" ; This name goes into the modeline.
112        local-abbrev-table    tablegen-mode-abbrev-table
113	font-lock-defaults    `(tablegen-font-lock-keywords)
114	require-final-newline t
115        )
116
117  (set-syntax-table tablegen-mode-syntax-table)
118  (make-local-variable 'comment-start)
119  (setq comment-start "//")
120  (setq indent-tabs-mode nil)
121  (run-hooks 'tablegen-mode-hook))       ; Finally, this permits the user to
122                                         ;   customize the mode with a hook.
123
124;; Associate .td files with tablegen-mode
125;;;###autoload
126(add-to-list 'auto-mode-alist (cons (purecopy "\\.td\\'")  'tablegen-mode))
127
128(provide 'tablegen-mode)
129
130;;; tablegen-mode.el ends here
131