Mercurial > emacs
annotate lisp/progmodes/asm-mode.el @ 14108:cab8d383f10d
(easy-menu-define): Doc fix.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Tue, 09 Jan 1996 23:16:13 +0000 |
parents | 8963d6de6f07 |
children | 83f275dcd93a |
rev | line source |
---|---|
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
1 ;;; asm-mode.el --- mode for editing assembler code |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
2 |
869 | 3 ;; Copyright (C) 1991 Free Software Foundation, Inc. |
4 | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> |
11098 | 6 ;; Maintainer: FSF |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
7 ;; Keywords: tools, languages |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
8 |
473 | 9 ;; This file is part of GNU Emacs. |
10 | |
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 | |
869 | 13 ;; the Free Software Foundation; either version 2, or (at your option) |
473 | 14 ;; any later version. |
15 | |
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. | |
20 | |
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 | |
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
24 | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
25 ;;; Commentary: |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
26 |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
27 ;; This mode was written by Eric S. Raymond <esr@snark.thyrsus.com>, |
473 | 28 ;; inspired by an earlier asm-mode by Martin Neitzel. |
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 | |
11105
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
36 ;; comment char place or move comment |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
37 ;; asm-comment-char specifies which character this is; |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
38 ;; you can use a different character in different |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
39 ;; Asm mode buffers. |
473 | 40 ;; C-j, C-m newline and tab to tab stop |
41 ;; | |
42 ;; Code is indented to the first tab stop level. | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
43 |
473 | 44 ;; This mode runs two hooks: |
11098 | 45 ;; 1) An asm-mode-set-comment-hook before the part of the initialization |
473 | 46 ;; depending on asm-comment-char, and |
47 ;; 2) an asm-mode-hook at the end of initialization. | |
48 | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
49 ;;; Code: |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
50 |
473 | 51 (defvar asm-comment-char ?; |
2670 | 52 "*The comment-start character assumed by Asm mode.") |
473 | 53 |
54 (defvar asm-mode-syntax-table nil | |
2670 | 55 "Syntax table used while in Asm mode.") |
473 | 56 |
57 (defvar asm-mode-abbrev-table nil | |
2670 | 58 "Abbrev table used while in Asm mode.") |
473 | 59 (define-abbrev-table 'asm-mode-abbrev-table ()) |
60 | |
61 (defvar asm-mode-map nil | |
2670 | 62 "Keymap for Asm mode.") |
473 | 63 |
64 (if asm-mode-map | |
65 nil | |
66 (setq asm-mode-map (make-sparse-keymap)) | |
11105
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
67 ;; Note that the comment character isn't set up until asm-mode is called. |
473 | 68 (define-key asm-mode-map ":" 'asm-colon) |
69 (define-key asm-mode-map "\C-i" 'tab-to-tab-stop) | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
70 (define-key asm-mode-map "\C-j" 'asm-newline) |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
71 (define-key asm-mode-map "\C-m" 'asm-newline) |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
72 ) |
473 | 73 |
9385
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
74 (defconst asm-font-lock-keywords |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
75 '(("^\\(\\(\\sw\\|\\s_\\)+\\)\\>:?[ \t]*\\(\\sw+\\)?" |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
76 (1 font-lock-function-name-face) (3 font-lock-keyword-face nil t)) |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
77 ("^\\s +\\(\\(\\sw\\|\\s_\\)+\\)" 1 font-lock-keyword-face)) |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
78 "Additional expressions to highlight in Assembler mode.") |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
79 |
473 | 80 (defvar asm-code-level-empty-comment-pattern nil) |
81 (defvar asm-flush-left-empty-comment-pattern nil) | |
82 (defvar asm-inline-empty-comment-pattern nil) | |
83 | |
84 ;;;###autoload | |
85 (defun asm-mode () | |
86 "Major mode for editing typical assembler code. | |
2670 | 87 Features a private abbrev table and the following bindings: |
473 | 88 |
89 \\[asm-colon]\toutdent a preceding label, tab to next tab stop. | |
90 \\[tab-to-tab-stop]\ttab to next tab stop. | |
91 \\[asm-newline]\tnewline, then tab to next tab stop. | |
92 \\[asm-comment]\tsmart placement of assembler comments. | |
93 | |
94 The character used for making comments is set by the variable | |
2670 | 95 `asm-comment-char' (which defaults to `?;'). |
473 | 96 |
11098 | 97 Alternatively, you may set this variable in `asm-mode-set-comment-hook', |
98 which is called near the beginning of mode initialization. | |
473 | 99 |
2670 | 100 Turning on Asm mode runs the hook `asm-mode-hook' at the end of initialization. |
473 | 101 |
6469 | 102 Special commands: |
103 \\{asm-mode-map} | |
473 | 104 " |
105 (interactive) | |
106 (kill-all-local-variables) | |
107 (setq mode-name "Assembler") | |
108 (setq major-mode 'asm-mode) | |
109 (setq local-abbrev-table asm-mode-abbrev-table) | |
9472
06623e3543db
* asm-mode.el: (asm-mode): Set font-lock-defaults.
Simon Marshall <simon@gnu.org>
parents:
9385
diff
changeset
|
110 (make-local-variable 'font-lock-defaults) |
06623e3543db
* asm-mode.el: (asm-mode): Set font-lock-defaults.
Simon Marshall <simon@gnu.org>
parents:
9385
diff
changeset
|
111 (setq font-lock-defaults '(asm-font-lock-keywords)) |
473 | 112 (make-local-variable 'asm-mode-syntax-table) |
113 (setq asm-mode-syntax-table (make-syntax-table)) | |
114 (set-syntax-table asm-mode-syntax-table) | |
11105
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
115 |
473 | 116 (run-hooks 'asm-mode-set-comment-hook) |
11105
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
117 ;; Make our own local child of asm-mode-map |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
118 ;; so we can define our own comment character. |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
119 (use-local-map (nconc (make-sparse-keymap) asm-mode-map)) |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
120 (local-set-key (vector asm-comment-char) 'asm-comment) |
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
121 |
473 | 122 (modify-syntax-entry asm-comment-char |
123 "<" asm-mode-syntax-table) | |
124 (modify-syntax-entry ?\n | |
125 ">" asm-mode-syntax-table) | |
126 (let ((cs (regexp-quote (char-to-string asm-comment-char)))) | |
127 (make-local-variable 'comment-start) | |
128 (setq comment-start (concat cs " ")) | |
129 (make-local-variable 'comment-start-skip) | |
130 (setq comment-start-skip (concat cs "+[ \t]*")) | |
131 (setq asm-inline-empty-comment-pattern (concat "^.+" cs "+ *$")) | |
132 (setq asm-code-level-empty-comment-pattern (concat "^[\t ]+" cs cs " *$")) | |
133 (setq asm-flush-left-empty-comment-pattern (concat "^" cs cs cs " *$")) | |
134 ) | |
135 (make-local-variable 'comment-end) | |
136 (setq comment-end "") | |
137 (make-local-variable 'comment-column) | |
138 (setq comment-column 32) | |
139 (setq fill-prefix "\t") | |
11105
8963d6de6f07
(asm-mode): Make a per-buffer child keymap here.
Richard M. Stallman <rms@gnu.org>
parents:
11098
diff
changeset
|
140 (run-hooks 'asm-mode-hook)) |
473 | 141 |
142 (defun asm-colon () | |
143 "Insert a colon; if it follows a label, delete the label's indentation." | |
144 (interactive) | |
145 (save-excursion | |
146 (beginning-of-line) | |
147 (if (looking-at "[ \t]+\\(\\sw\\|\\s_\\)+$") | |
148 (delete-horizontal-space))) | |
149 (insert ":") | |
150 (tab-to-tab-stop) | |
151 ) | |
152 | |
153 (defun asm-newline () | |
154 "Insert LFD + fill-prefix, to bring us back to code-indent level." | |
155 (interactive) | |
156 (if (eolp) (delete-horizontal-space)) | |
157 (insert "\n") | |
158 (tab-to-tab-stop) | |
159 ) | |
160 | |
161 (defun asm-line-matches (pattern &optional withcomment) | |
162 (save-excursion | |
163 (beginning-of-line) | |
164 (looking-at pattern))) | |
165 | |
166 (defun asm-pop-comment-level () | |
167 ;; Delete an empty comment ending current line. Then set up for a new one, | |
168 ;; on the current line if it was all comment, otherwise above it | |
169 (end-of-line) | |
170 (delete-horizontal-space) | |
171 (while (= (preceding-char) asm-comment-char) | |
172 (delete-backward-char 1)) | |
173 (delete-horizontal-space) | |
174 (if (bolp) | |
175 nil | |
176 (beginning-of-line) | |
177 (open-line 1)) | |
178 ) | |
179 | |
180 | |
181 (defun asm-comment () | |
182 "Convert an empty comment to a `larger' kind, or start a new one. | |
183 These are the known comment classes: | |
184 | |
185 1 -- comment to the right of the code (at the comment-column) | |
186 2 -- comment on its own line, indented like code | |
187 3 -- comment on its own line, beginning at the left-most column. | |
188 | |
189 Suggested usage: while writing your code, trigger asm-comment | |
190 repeatedly until you are satisfied with the kind of comment." | |
191 (interactive) | |
192 (cond | |
193 | |
194 ;; Blank line? Then start comment at code indent level. | |
195 ((asm-line-matches "^[ \t]*$") | |
196 (delete-horizontal-space) | |
197 (tab-to-tab-stop) | |
198 (insert asm-comment-char comment-start)) | |
199 | |
200 ;; Nonblank line with no comment chars in it? | |
201 ;; Then start a comment at the current comment column | |
7384
2395bbd3dd6e
(asm-comment): Don't match newline.
Karl Heuer <kwzh@gnu.org>
parents:
6469
diff
changeset
|
202 ((asm-line-matches (format "^[^%c\n]+$" asm-comment-char)) |
473 | 203 (indent-for-comment)) |
204 | |
205 ;; Flush-left comment present? Just insert character. | |
206 ((asm-line-matches asm-flush-left-empty-comment-pattern) | |
207 (insert asm-comment-char)) | |
208 | |
209 ;; Empty code-level comment already present? | |
210 ;; Then start flush-left comment, on line above if this one is nonempty. | |
211 ((asm-line-matches asm-code-level-empty-comment-pattern) | |
212 (asm-pop-comment-level) | |
213 (insert asm-comment-char asm-comment-char comment-start)) | |
214 | |
215 ;; Empty comment ends line? | |
216 ;; Then make code-level comment, on line above if this one is nonempty. | |
217 ((asm-line-matches asm-inline-empty-comment-pattern) | |
218 (asm-pop-comment-level) | |
219 (tab-to-tab-stop) | |
220 (insert asm-comment-char comment-start)) | |
221 | |
222 ;; If all else fails, insert character | |
223 (t | |
224 (insert asm-comment-char)) | |
225 | |
226 ) | |
227 (end-of-line)) | |
228 | |
229 ;;; asm-mode.el ends here |