Commit | Line | Data |
---|---|---|
f961a17c ER |
1 | ;;; asm-mode.el --- mode for editing assembler code |
2 | ||
4e643dd2 | 3 | ;; Copyright (C) 1991, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
034babe1 | 4 | ;; Free Software Foundation, Inc. |
1bd60093 | 5 | |
f961a17c | 6 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> |
148d2a8d | 7 | ;; Maintainer: FSF |
f961a17c ER |
8 | ;; Keywords: tools, languages |
9 | ||
0231f2dc JB |
10 | ;; This file is part of GNU Emacs. |
11 | ||
b1fc2b50 | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
0231f2dc | 13 | ;; it under the terms of the GNU General Public License as published by |
b1fc2b50 GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
0231f2dc JB |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b1fc2b50 | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
0231f2dc | 24 | |
f961a17c ER |
25 | ;;; Commentary: |
26 | ||
27 | ;; This mode was written by Eric S. Raymond <esr@snark.thyrsus.com>, | |
0231f2dc | 28 | ;; inspired by an earlier asm-mode by Martin Neitzel. |
0231f2dc JB |
29 | |
30 | ;; This minor mode is based on text mode. It defines a private abbrev table | |
31 | ;; that can be used to save abbrevs for assembler mnemonics. It binds just | |
32 | ;; five keys: | |
33 | ;; | |
34 | ;; TAB tab to next tab stop | |
35 | ;; : outdent preceding label, tab to tab stop | |
f45a220a RS |
36 | ;; comment char place or move comment |
37 | ;; asm-comment-char specifies which character this is; | |
38 | ;; you can use a different character in different | |
39 | ;; Asm mode buffers. | |
0231f2dc JB |
40 | ;; C-j, C-m newline and tab to tab stop |
41 | ;; | |
42 | ;; Code is indented to the first tab stop level. | |
f961a17c | 43 | |
0231f2dc | 44 | ;; This mode runs two hooks: |
148d2a8d | 45 | ;; 1) An asm-mode-set-comment-hook before the part of the initialization |
0231f2dc JB |
46 | ;; depending on asm-comment-char, and |
47 | ;; 2) an asm-mode-hook at the end of initialization. | |
48 | ||
f961a17c ER |
49 | ;;; Code: |
50 | ||
28d16ed3 AS |
51 | (defgroup asm nil |
52 | "Mode for editing assembler code." | |
8ec3bce0 | 53 | :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces) |
28d16ed3 AS |
54 | :group 'languages) |
55 | ||
1ce965fe | 56 | (defcustom asm-comment-char ?\; |
28d16ed3 AS |
57 | "*The comment-start character assumed by Asm mode." |
58 | :type 'character | |
59 | :group 'asm) | |
0231f2dc | 60 | |
c7d565f4 SM |
61 | (defvar asm-mode-syntax-table |
62 | (let ((st (make-syntax-table))) | |
0db097a5 MY |
63 | (modify-syntax-entry ?\n "> b" st) |
64 | (modify-syntax-entry ?/ ". 124b" st) | |
65 | (modify-syntax-entry ?* ". 23" st) | |
c7d565f4 | 66 | st) |
1d928d69 | 67 | "Syntax table used while in Asm mode.") |
0231f2dc JB |
68 | |
69 | (defvar asm-mode-abbrev-table nil | |
1d928d69 | 70 | "Abbrev table used while in Asm mode.") |
0231f2dc JB |
71 | (define-abbrev-table 'asm-mode-abbrev-table ()) |
72 | ||
c7d565f4 SM |
73 | (defvar asm-mode-map |
74 | (let ((map (make-sparse-keymap))) | |
75 | ;; Note that the comment character isn't set up until asm-mode is called. | |
76 | (define-key map ":" 'asm-colon) | |
77 | (define-key map "\C-c;" 'comment-region) | |
dfc42f38 SM |
78 | (define-key map "\C-j" 'newline-and-indent) |
79 | (define-key map "\C-m" 'newline-and-indent) | |
187e9721 DN |
80 | (define-key map [menu-bar] (make-sparse-keymap)) |
81 | (define-key map [menu-bar asm-mode] (cons "Asm" map)) | |
187e9721 | 82 | (define-key map [comment-region] |
61acee99 DN |
83 | '(menu-item "Comment Region" comment-region |
84 | :help "Comment or uncomment each line in the region")) | |
187e9721 | 85 | (define-key map [newline-and-indent] |
61acee99 DN |
86 | '(menu-item "Insert Newline and Indent" newline-and-indent |
87 | :help "Insert a newline, then indent according to major mode")) | |
88 | (define-key map [asm-colon] | |
89 | '(menu-item "Insert Colon" asm-colon | |
90 | :help "Insert a colon; if it follows a label, delete the label's indentation")) | |
c7d565f4 | 91 | map) |
1d928d69 | 92 | "Keymap for Asm mode.") |
0231f2dc | 93 | |
a4d8ed20 | 94 | (defconst asm-font-lock-keywords |
4076cbf6 MY |
95 | (append |
96 | '(("^\\(\\(\\sw\\|\\s_\\)+\\)\\>:?[ \t]*\\(\\sw+\\(\\.\\sw+\\)*\\)?" | |
97 | (1 font-lock-function-name-face) (3 font-lock-keyword-face nil t)) | |
98 | ;; label started from ".". | |
99 | ("^\\(\\.\\(\\sw\\|\\s_\\)+\\)\\>:" | |
100 | 1 font-lock-function-name-face) | |
101 | ("^\\((\\sw+)\\)?\\s +\\(\\(\\.?\\sw\\|\\s_\\)+\\(\\.\\sw+\\)*\\)" | |
102 | 2 font-lock-keyword-face) | |
103 | ;; directive started from ".". | |
104 | ("^\\(\\.\\(\\sw\\|\\s_\\)+\\)\\>[^:]?" | |
105 | 1 font-lock-keyword-face) | |
106 | ;; %register | |
107 | ("%\\sw+" . font-lock-variable-name-face)) | |
108 | cpp-font-lock-keywords) | |
109 | "Additional expressions to highlight in Assembler mode.") | |
a4d8ed20 | 110 | |
0231f2dc JB |
111 | ;;;###autoload |
112 | (defun asm-mode () | |
113 | "Major mode for editing typical assembler code. | |
1d928d69 | 114 | Features a private abbrev table and the following bindings: |
0231f2dc JB |
115 | |
116 | \\[asm-colon]\toutdent a preceding label, tab to next tab stop. | |
117 | \\[tab-to-tab-stop]\ttab to next tab stop. | |
118 | \\[asm-newline]\tnewline, then tab to next tab stop. | |
119 | \\[asm-comment]\tsmart placement of assembler comments. | |
120 | ||
121 | The character used for making comments is set by the variable | |
1ce965fe | 122 | `asm-comment-char' (which defaults to `?\\;'). |
0231f2dc | 123 | |
148d2a8d RS |
124 | Alternatively, you may set this variable in `asm-mode-set-comment-hook', |
125 | which is called near the beginning of mode initialization. | |
0231f2dc | 126 | |
1d928d69 | 127 | Turning on Asm mode runs the hook `asm-mode-hook' at the end of initialization. |
0231f2dc | 128 | |
18e3ab41 | 129 | Special commands: |
c7d565f4 | 130 | \\{asm-mode-map}" |
0231f2dc JB |
131 | (interactive) |
132 | (kill-all-local-variables) | |
0231f2dc JB |
133 | (setq mode-name "Assembler") |
134 | (setq major-mode 'asm-mode) | |
135 | (setq local-abbrev-table asm-mode-abbrev-table) | |
788a3a2b SM |
136 | (make-local-variable 'font-lock-defaults) |
137 | (setq font-lock-defaults '(asm-font-lock-keywords)) | |
dfc42f38 SM |
138 | (set (make-local-variable 'indent-line-function) 'asm-indent-line) |
139 | ;; Stay closer to the old TAB behavior (was tab-to-tab-stop). | |
140 | (set (make-local-variable 'tab-always-indent) nil) | |
f45a220a | 141 | |
0231f2dc | 142 | (run-hooks 'asm-mode-set-comment-hook) |
f45a220a RS |
143 | ;; Make our own local child of asm-mode-map |
144 | ;; so we can define our own comment character. | |
145 | (use-local-map (nconc (make-sparse-keymap) asm-mode-map)) | |
146 | (local-set-key (vector asm-comment-char) 'asm-comment) | |
c7d565f4 | 147 | (set-syntax-table (make-syntax-table asm-mode-syntax-table)) |
0db097a5 | 148 | (modify-syntax-entry asm-comment-char "< b") |
c7d565f4 SM |
149 | |
150 | (make-local-variable 'comment-start) | |
dfc42f38 SM |
151 | (setq comment-start (string asm-comment-char)) |
152 | (make-local-variable 'comment-add) | |
153 | (setq comment-add 1) | |
c7d565f4 | 154 | (make-local-variable 'comment-start-skip) |
0db097a5 | 155 | (setq comment-start-skip "\\(?:\\s<+\\|/[/*]+\\)[ \t]*") |
c7d565f4 | 156 | (make-local-variable 'comment-end-skip) |
dfc42f38 | 157 | (setq comment-end-skip "[ \t]*\\(\\s>\\|\\*+/\\)") |
0231f2dc JB |
158 | (make-local-variable 'comment-end) |
159 | (setq comment-end "") | |
0231f2dc | 160 | (setq fill-prefix "\t") |
dfc42f38 SM |
161 | (run-mode-hooks 'asm-mode-hook)) |
162 | ||
163 | (defun asm-indent-line () | |
164 | "Auto-indent the current line." | |
165 | (interactive) | |
166 | (let* ((savep (point)) | |
167 | (indent (condition-case nil | |
168 | (save-excursion | |
169 | (forward-line 0) | |
170 | (skip-chars-forward " \t") | |
171 | (if (>= (point) savep) (setq savep nil)) | |
172 | (max (asm-calculate-indentation) 0)) | |
173 | (error 0)))) | |
174 | (if savep | |
175 | (save-excursion (indent-line-to indent)) | |
176 | (indent-line-to indent)))) | |
177 | ||
178 | (defun asm-calculate-indentation () | |
179 | (or | |
180 | ;; Flush labels to the left margin. | |
181 | (and (looking-at "\\(\\sw\\|\\s_\\)+:") 0) | |
182 | ;; Same thing for `;;;' comments. | |
183 | (and (looking-at "\\s<\\s<\\s<") 0) | |
184 | ;; Simple `;' comments go to the comment-column. | |
185 | (and (looking-at "\\s<\\(\\S<\\|\\'\\)") comment-column) | |
186 | ;; The rest goes at the first tab stop. | |
187 | (or (car tab-stop-list) tab-width))) | |
188 | ||
0231f2dc JB |
189 | (defun asm-colon () |
190 | "Insert a colon; if it follows a label, delete the label's indentation." | |
191 | (interactive) | |
dfc42f38 SM |
192 | (let ((labelp nil)) |
193 | (save-excursion | |
194 | (skip-syntax-backward "w_") | |
195 | (skip-syntax-backward " ") | |
196 | (if (setq labelp (bolp)) (delete-horizontal-space))) | |
197 | (call-interactively 'self-insert-command) | |
198 | (when labelp | |
199 | (delete-horizontal-space) | |
200 | (tab-to-tab-stop)))) | |
201 | ||
bf247b6e | 202 | ;; Obsolete since Emacs-22.1. |
dfc42f38 | 203 | (defalias 'asm-newline 'newline-and-indent) |
0231f2dc JB |
204 | |
205 | (defun asm-comment () | |
206 | "Convert an empty comment to a `larger' kind, or start a new one. | |
207 | These are the known comment classes: | |
208 | ||
209 | 1 -- comment to the right of the code (at the comment-column) | |
210 | 2 -- comment on its own line, indented like code | |
211 | 3 -- comment on its own line, beginning at the left-most column. | |
212 | ||
213 | Suggested usage: while writing your code, trigger asm-comment | |
214 | repeatedly until you are satisfied with the kind of comment." | |
215 | (interactive) | |
dfc42f38 SM |
216 | (comment-normalize-vars) |
217 | (let (comempty comment) | |
218 | (save-excursion | |
219 | (beginning-of-line) | |
434fc2d3 RS |
220 | (with-no-warnings |
221 | (setq comment (comment-search-forward (line-end-position) t))) | |
dfc42f38 SM |
222 | (setq comempty (looking-at "[ \t]*$"))) |
223 | ||
0231f2dc JB |
224 | (cond |
225 | ||
226 | ;; Blank line? Then start comment at code indent level. | |
dfc42f38 SM |
227 | ;; Just like `comment-dwim'. -stef |
228 | ((save-excursion (beginning-of-line) (looking-at "^[ \t]*$")) | |
229 | (indent-according-to-mode) | |
230 | (insert asm-comment-char asm-comment-char ?\ )) | |
231 | ||
232 | ;; Nonblank line w/o comment => start a comment at comment-column. | |
233 | ;; Also: point before the comment => jump inside. | |
234 | ((or (null comment) (< (point) comment)) | |
0231f2dc JB |
235 | (indent-for-comment)) |
236 | ||
dfc42f38 SM |
237 | ;; Flush-left or non-empty comment present => just insert character. |
238 | ((or (not comempty) (save-excursion (goto-char comment) (bolp))) | |
0231f2dc JB |
239 | (insert asm-comment-char)) |
240 | ||
dfc42f38 SM |
241 | ;; Empty code-level comment => upgrade to next comment level. |
242 | ((save-excursion (goto-char comment) (skip-chars-backward " \t") (bolp)) | |
243 | (goto-char comment) | |
244 | (insert asm-comment-char) | |
245 | (indent-for-comment)) | |
0231f2dc | 246 | |
dfc42f38 | 247 | ;; Empty comment ends non-empty code line => new comment above. |
0231f2dc | 248 | (t |
dfc42f38 SM |
249 | (goto-char comment) |
250 | (skip-chars-backward " \t") | |
251 | (delete-region (point) (line-end-position)) | |
252 | (beginning-of-line) (insert "\n") (backward-char) | |
253 | (asm-comment))))) | |
0231f2dc | 254 | |
896546cd RS |
255 | (provide 'asm-mode) |
256 | ||
cbee283d | 257 | ;; arch-tag: 210e695f-f338-4376-8913-a4c5c72ac848 |
0231f2dc | 258 | ;;; asm-mode.el ends here |