1 ;;; asm-mode.el --- mode for editing assembler code
3 ;; Copyright (C) 1991, 2003 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
7 ;; Keywords: tools, languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This mode was written by Eric S. Raymond <esr@snark.thyrsus.com>,
29 ;; inspired by an earlier asm-mode by Martin Neitzel.
31 ;; This minor mode is based on text mode. It defines a private abbrev table
32 ;; that can be used to save abbrevs for assembler mnemonics. It binds just
35 ;; TAB tab to next tab stop
36 ;; : outdent preceding label, tab to tab stop
37 ;; comment char place or move comment
38 ;; asm-comment-char specifies which character this is;
39 ;; you can use a different character in different
41 ;; C-j, C-m newline and tab to tab stop
43 ;; Code is indented to the first tab stop level.
45 ;; This mode runs two hooks:
46 ;; 1) An asm-mode-set-comment-hook before the part of the initialization
47 ;; depending on asm-comment-char, and
48 ;; 2) an asm-mode-hook at the end of initialization.
53 "Mode for editing assembler code."
56 (defcustom asm-comment-char ?\
;
57 "*The comment-start character assumed by Asm mode."
61 (defvar asm-mode-syntax-table
62 (let ((st (make-syntax-table)))
63 (modify-syntax-entry ?
\n ">" st
)
64 (modify-syntax-entry ?
/ ". 14b" st
)
65 (modify-syntax-entry ?
* ". 23b" st
)
67 "Syntax table used while in Asm mode.")
69 (defvar asm-mode-abbrev-table nil
70 "Abbrev table used while in Asm mode.")
71 (define-abbrev-table 'asm-mode-abbrev-table
())
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
)
78 (define-key map
"\C-j" 'newline-and-indent
)
79 (define-key map
"\C-m" 'newline-and-indent
)
81 "Keymap for Asm mode.")
83 (defconst asm-font-lock-keywords
84 '(("^\\(\\(\\sw\\|\\s_\\)+\\)\\>:?[ \t]*\\(\\sw+\\(\\.\\sw+\\)*\\)?"
85 (1 font-lock-function-name-face
) (3 font-lock-keyword-face nil t
))
86 ;; label started from ".".
87 ("^\\(\\.\\(\\sw\\|\\s_\\)+\\)\\>:"
88 1 font-lock-function-name-face
)
89 ("^\\((\\sw+)\\)?\\s +\\(\\(\\.?\\sw\\|\\s_\\)+\\(\\.\\sw+\\)*\\)"
90 2 font-lock-keyword-face
)
91 ;; directive started from ".".
92 ("^\\(\\.\\(\\sw\\|\\s_\\)+\\)\\>[^:]?"
93 1 font-lock-keyword-face
)
95 ("%\\sw+" . font-lock-variable-name-face
))
96 "Additional expressions to highlight in Assembler mode.")
100 "Major mode for editing typical assembler code.
101 Features a private abbrev table and the following bindings:
103 \\[asm-colon]\toutdent a preceding label, tab to next tab stop.
104 \\[tab-to-tab-stop]\ttab to next tab stop.
105 \\[asm-newline]\tnewline, then tab to next tab stop.
106 \\[asm-comment]\tsmart placement of assembler comments.
108 The character used for making comments is set by the variable
109 `asm-comment-char' (which defaults to `?\\;').
111 Alternatively, you may set this variable in `asm-mode-set-comment-hook',
112 which is called near the beginning of mode initialization.
114 Turning on Asm mode runs the hook `asm-mode-hook' at the end of initialization.
119 (kill-all-local-variables)
120 (setq mode-name
"Assembler")
121 (setq major-mode
'asm-mode
)
122 (setq local-abbrev-table asm-mode-abbrev-table
)
123 (make-local-variable 'font-lock-defaults
)
124 (setq font-lock-defaults
'(asm-font-lock-keywords))
125 (set (make-local-variable 'indent-line-function
) 'asm-indent-line
)
126 ;; Stay closer to the old TAB behavior (was tab-to-tab-stop).
127 (set (make-local-variable 'tab-always-indent
) nil
)
129 (run-hooks 'asm-mode-set-comment-hook
)
130 ;; Make our own local child of asm-mode-map
131 ;; so we can define our own comment character.
132 (use-local-map (nconc (make-sparse-keymap) asm-mode-map
))
133 (local-set-key (vector asm-comment-char
) 'asm-comment
)
134 (set-syntax-table (make-syntax-table asm-mode-syntax-table
))
135 (modify-syntax-entry asm-comment-char
"<")
137 (make-local-variable 'comment-start
)
138 (setq comment-start
(string asm-comment-char
))
139 (make-local-variable 'comment-add
)
141 (make-local-variable 'comment-start-skip
)
142 (setq comment-start-skip
"\\(?:\\s<+\\|/\\*+\\)[ \t]*")
143 (make-local-variable 'comment-end-skip
)
144 (setq comment-end-skip
"[ \t]*\\(\\s>\\|\\*+/\\)")
145 (make-local-variable 'comment-end
)
146 (setq comment-end
"")
147 (setq fill-prefix
"\t")
148 (run-mode-hooks 'asm-mode-hook
))
150 (defun asm-indent-line ()
151 "Auto-indent the current line."
153 (let* ((savep (point))
154 (indent (condition-case nil
157 (skip-chars-forward " \t")
158 (if (>= (point) savep
) (setq savep nil
))
159 (max (asm-calculate-indentation) 0))
162 (save-excursion (indent-line-to indent
))
163 (indent-line-to indent
))))
165 (defun asm-calculate-indentation ()
167 ;; Flush labels to the left margin.
168 (and (looking-at "\\(\\sw\\|\\s_\\)+:") 0)
169 ;; Same thing for `;;;' comments.
170 (and (looking-at "\\s<\\s<\\s<") 0)
171 ;; Simple `;' comments go to the comment-column.
172 (and (looking-at "\\s<\\(\\S<\\|\\'\\)") comment-column
)
173 ;; The rest goes at the first tab stop.
174 (or (car tab-stop-list
) tab-width
)))
177 "Insert a colon; if it follows a label, delete the label's indentation."
181 (skip-syntax-backward "w_")
182 (skip-syntax-backward " ")
183 (if (setq labelp
(bolp)) (delete-horizontal-space)))
184 (call-interactively 'self-insert-command
)
186 (delete-horizontal-space)
189 ;; Obsolete since Emacs-22.1.
190 (defalias 'asm-newline
'newline-and-indent
)
192 (defun asm-comment ()
193 "Convert an empty comment to a `larger' kind, or start a new one.
194 These are the known comment classes:
196 1 -- comment to the right of the code (at the comment-column)
197 2 -- comment on its own line, indented like code
198 3 -- comment on its own line, beginning at the left-most column.
200 Suggested usage: while writing your code, trigger asm-comment
201 repeatedly until you are satisfied with the kind of comment."
203 (comment-normalize-vars)
204 (let (comempty comment
)
207 (setq comment
(comment-search-forward (line-end-position) t
))
208 (setq comempty
(looking-at "[ \t]*$")))
212 ;; Blank line? Then start comment at code indent level.
213 ;; Just like `comment-dwim'. -stef
214 ((save-excursion (beginning-of-line) (looking-at "^[ \t]*$"))
215 (indent-according-to-mode)
216 (insert asm-comment-char asm-comment-char ?\
))
218 ;; Nonblank line w/o comment => start a comment at comment-column.
219 ;; Also: point before the comment => jump inside.
220 ((or (null comment
) (< (point) comment
))
221 (indent-for-comment))
223 ;; Flush-left or non-empty comment present => just insert character.
224 ((or (not comempty
) (save-excursion (goto-char comment
) (bolp)))
225 (insert asm-comment-char
))
227 ;; Empty code-level comment => upgrade to next comment level.
228 ((save-excursion (goto-char comment
) (skip-chars-backward " \t") (bolp))
230 (insert asm-comment-char
)
231 (indent-for-comment))
233 ;; Empty comment ends non-empty code line => new comment above.
236 (skip-chars-backward " \t")
237 (delete-region (point) (line-end-position))
238 (beginning-of-line) (insert "\n") (backward-char)
243 ;;; arch-tag: 210e695f-f338-4376-8913-a4c5c72ac848
244 ;;; asm-mode.el ends here