Mercurial > emacs
annotate lisp/progmodes/asm-mode.el @ 11098:03b481b6cec2
Doc fixes.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 22 Mar 1995 21:31:08 +0000 |
parents | 06623e3543db |
children | 8963d6de6f07 |
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 | |
36 ;; ; place or move comment | |
37 ;; C-j, C-m newline and tab to tab stop | |
38 ;; | |
39 ;; Code is indented to the first tab stop level. | |
40 ;; The ; key inserts copies of the value of asm-comment-char at an | |
41 ;; appropriate spot. | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
42 |
473 | 43 ;; This mode runs two hooks: |
11098 | 44 ;; 1) An asm-mode-set-comment-hook before the part of the initialization |
473 | 45 ;; depending on asm-comment-char, and |
46 ;; 2) an asm-mode-hook at the end of initialization. | |
47 | |
810
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
48 ;;; Code: |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
49 |
473 | 50 (defvar asm-comment-char ?; |
2670 | 51 "*The comment-start character assumed by Asm mode.") |
473 | 52 |
53 (defvar asm-mode-syntax-table nil | |
2670 | 54 "Syntax table used while in Asm mode.") |
473 | 55 |
56 (defvar asm-mode-abbrev-table nil | |
2670 | 57 "Abbrev table used while in Asm mode.") |
473 | 58 (define-abbrev-table 'asm-mode-abbrev-table ()) |
59 | |
60 (defvar asm-mode-map nil | |
2670 | 61 "Keymap for Asm mode.") |
473 | 62 |
63 (if asm-mode-map | |
64 nil | |
65 (setq asm-mode-map (make-sparse-keymap)) | |
66 (define-key asm-mode-map ";" 'asm-comment) | |
67 (define-key asm-mode-map ":" 'asm-colon) | |
68 (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
|
69 (define-key asm-mode-map "\C-j" 'asm-newline) |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
70 (define-key asm-mode-map "\C-m" 'asm-newline) |
80303373daae
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
803
diff
changeset
|
71 ) |
473 | 72 |
9385
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
73 (defconst asm-font-lock-keywords |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
74 '(("^\\(\\(\\sw\\|\\s_\\)+\\)\\>:?[ \t]*\\(\\sw+\\)?" |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
75 (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
|
76 ("^\\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
|
77 "Additional expressions to highlight in Assembler mode.") |
297f0781c8ae
(asm-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
7384
diff
changeset
|
78 |
473 | 79 (defvar asm-code-level-empty-comment-pattern nil) |
80 (defvar asm-flush-left-empty-comment-pattern nil) | |
81 (defvar asm-inline-empty-comment-pattern nil) | |
82 | |
83 ;;;###autoload | |
84 (defun asm-mode () | |
85 "Major mode for editing typical assembler code. | |
2670 | 86 Features a private abbrev table and the following bindings: |
473 | 87 |
88 \\[asm-colon]\toutdent a preceding label, tab to next tab stop. | |
89 \\[tab-to-tab-stop]\ttab to next tab stop. | |
90 \\[asm-newline]\tnewline, then tab to next tab stop. | |
91 \\[asm-comment]\tsmart placement of assembler comments. | |
92 | |
93 The character used for making comments is set by the variable | |
2670 | 94 `asm-comment-char' (which defaults to `?;'). |
473 | 95 |
11098 | 96 Alternatively, you may set this variable in `asm-mode-set-comment-hook', |
97 which is called near the beginning of mode initialization. | |
473 | 98 |
2670 | 99 Turning on Asm mode runs the hook `asm-mode-hook' at the end of initialization. |
473 | 100 |
6469 | 101 Special commands: |
102 \\{asm-mode-map} | |
473 | 103 " |
104 (interactive) | |
105 (kill-all-local-variables) | |
106 (use-local-map asm-mode-map) | |
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) | |
115 (run-hooks 'asm-mode-set-comment-hook) | |
116 (modify-syntax-entry asm-comment-char | |
117 "<" asm-mode-syntax-table) | |
118 (modify-syntax-entry ?\n | |
119 ">" asm-mode-syntax-table) | |
120 (let ((cs (regexp-quote (char-to-string asm-comment-char)))) | |
121 (make-local-variable 'comment-start) | |
122 (setq comment-start (concat cs " ")) | |
123 (make-local-variable 'comment-start-skip) | |
124 (setq comment-start-skip (concat cs "+[ \t]*")) | |
125 (setq asm-inline-empty-comment-pattern (concat "^.+" cs "+ *$")) | |
126 (setq asm-code-level-empty-comment-pattern (concat "^[\t ]+" cs cs " *$")) | |
127 (setq asm-flush-left-empty-comment-pattern (concat "^" cs cs cs " *$")) | |
128 ) | |
129 (make-local-variable 'comment-end) | |
130 (setq comment-end "") | |
131 (make-local-variable 'comment-column) | |
132 (setq comment-column 32) | |
133 (setq fill-prefix "\t") | |
134 (run-hooks 'asm-mode-hook) | |
135 ) | |
136 | |
137 | |
138 (defun asm-colon () | |
139 "Insert a colon; if it follows a label, delete the label's indentation." | |
140 (interactive) | |
141 (save-excursion | |
142 (beginning-of-line) | |
143 (if (looking-at "[ \t]+\\(\\sw\\|\\s_\\)+$") | |
144 (delete-horizontal-space))) | |
145 (insert ":") | |
146 (tab-to-tab-stop) | |
147 ) | |
148 | |
149 (defun asm-newline () | |
150 "Insert LFD + fill-prefix, to bring us back to code-indent level." | |
151 (interactive) | |
152 (if (eolp) (delete-horizontal-space)) | |
153 (insert "\n") | |
154 (tab-to-tab-stop) | |
155 ) | |
156 | |
157 (defun asm-line-matches (pattern &optional withcomment) | |
158 (save-excursion | |
159 (beginning-of-line) | |
160 (looking-at pattern))) | |
161 | |
162 (defun asm-pop-comment-level () | |
163 ;; Delete an empty comment ending current line. Then set up for a new one, | |
164 ;; on the current line if it was all comment, otherwise above it | |
165 (end-of-line) | |
166 (delete-horizontal-space) | |
167 (while (= (preceding-char) asm-comment-char) | |
168 (delete-backward-char 1)) | |
169 (delete-horizontal-space) | |
170 (if (bolp) | |
171 nil | |
172 (beginning-of-line) | |
173 (open-line 1)) | |
174 ) | |
175 | |
176 | |
177 (defun asm-comment () | |
178 "Convert an empty comment to a `larger' kind, or start a new one. | |
179 These are the known comment classes: | |
180 | |
181 1 -- comment to the right of the code (at the comment-column) | |
182 2 -- comment on its own line, indented like code | |
183 3 -- comment on its own line, beginning at the left-most column. | |
184 | |
185 Suggested usage: while writing your code, trigger asm-comment | |
186 repeatedly until you are satisfied with the kind of comment." | |
187 (interactive) | |
188 (cond | |
189 | |
190 ;; Blank line? Then start comment at code indent level. | |
191 ((asm-line-matches "^[ \t]*$") | |
192 (delete-horizontal-space) | |
193 (tab-to-tab-stop) | |
194 (insert asm-comment-char comment-start)) | |
195 | |
196 ;; Nonblank line with no comment chars in it? | |
197 ;; 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
|
198 ((asm-line-matches (format "^[^%c\n]+$" asm-comment-char)) |
473 | 199 (indent-for-comment)) |
200 | |
201 ;; Flush-left comment present? Just insert character. | |
202 ((asm-line-matches asm-flush-left-empty-comment-pattern) | |
203 (insert asm-comment-char)) | |
204 | |
205 ;; Empty code-level comment already present? | |
206 ;; Then start flush-left comment, on line above if this one is nonempty. | |
207 ((asm-line-matches asm-code-level-empty-comment-pattern) | |
208 (asm-pop-comment-level) | |
209 (insert asm-comment-char asm-comment-char comment-start)) | |
210 | |
211 ;; Empty comment ends line? | |
212 ;; Then make code-level comment, on line above if this one is nonempty. | |
213 ((asm-line-matches asm-inline-empty-comment-pattern) | |
214 (asm-pop-comment-level) | |
215 (tab-to-tab-stop) | |
216 (insert asm-comment-char comment-start)) | |
217 | |
218 ;; If all else fails, insert character | |
219 (t | |
220 (insert asm-comment-char)) | |
221 | |
222 ) | |
223 (end-of-line)) | |
224 | |
225 ;;; asm-mode.el ends here |