X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/15ece07de68c1f207364242181d3c1f209b5beea..8a9cad92b1c9eecbdc9268a885413b7c5d08c7fa:/lisp/progmodes/asm-mode.el diff --git a/lisp/progmodes/asm-mode.el b/lisp/progmodes/asm-mode.el index d258475aef..76d12aa6f6 100644 --- a/lisp/progmodes/asm-mode.el +++ b/lisp/progmodes/asm-mode.el @@ -1,6 +1,10 @@ -;;; asm-mode.el --- Mode for editing assembler code +;;; asm-mode.el --- mode for editing assembler code -;; Copyright (C) 1991 Free Software Foundation, Inc. +;; Copyright (C) 1991, 2003 Free Software Foundation, Inc. + +;; Author: Eric S. Raymond +;; Maintainer: FSF +;; Keywords: tools, languages ;; This file is part of GNU Emacs. @@ -15,12 +19,14 @@ ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to -;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. +;; along with GNU Emacs; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. + +;;; Commentary: -;; This mode was written for Eric S. Raymond , +;; This mode was written by Eric S. Raymond , ;; inspired by an earlier asm-mode by Martin Neitzel. -;; @(#)asm-mode.el 1.1 ;; This minor mode is based on text mode. It defines a private abbrev table ;; that can be used to save abbrevs for assembler mnemonics. It binds just @@ -28,41 +34,64 @@ ;; ;; TAB tab to next tab stop ;; : outdent preceding label, tab to tab stop -;; ; place or move comment +;; comment char place or move comment +;; asm-comment-char specifies which character this is; +;; you can use a different character in different +;; Asm mode buffers. ;; C-j, C-m newline and tab to tab stop ;; ;; Code is indented to the first tab stop level. -;; The ; key inserts copies of the value of asm-comment-char at an -;; appropriate spot. + ;; This mode runs two hooks: -;; 1) An asm-set-comment-hook before the part of the initialization +;; 1) An asm-mode-set-comment-hook before the part of the initialization ;; depending on asm-comment-char, and ;; 2) an asm-mode-hook at the end of initialization. -(defvar asm-comment-char ?; - "*The comment-start character assumed by asm-mode.") +;;; Code: -(defvar asm-mode-syntax-table nil - "Syntax table used while in asm mode.") +(defgroup asm nil + "Mode for editing assembler code." + :group 'languages) -(defvar asm-mode-abbrev-table nil - "Abbrev table used while in asm mode.") -(define-abbrev-table 'asm-mode-abbrev-table ()) +(defcustom asm-comment-char ?\; + "*The comment-start character assumed by Asm mode." + :type 'character + :group 'asm) -(defvar asm-mode-map nil - "Keymap for asm-mode") +(defvar asm-mode-syntax-table + (let ((st (make-syntax-table))) + (modify-syntax-entry ?\n ">" st) + (modify-syntax-entry ?/ ". 14b" st) + (modify-syntax-entry ?* ". 23b" st) + st) + "Syntax table used while in Asm mode.") -(if asm-mode-map - nil - (setq asm-mode-map (make-sparse-keymap)) - (define-key asm-mode-map ";" 'asm-comment) - (define-key asm-mode-map ":" 'asm-colon) - (define-key asm-mode-map "\C-i" 'tab-to-tab-stop) - (define-key asm-mode-map "\C-j" 'asm-newline)) +(defvar asm-mode-abbrev-table nil + "Abbrev table used while in Asm mode.") +(define-abbrev-table 'asm-mode-abbrev-table ()) -(defvar asm-code-level-empty-comment-pattern nil) -(defvar asm-flush-left-empty-comment-pattern nil) -(defvar asm-inline-empty-comment-pattern nil) +(defvar asm-mode-map + (let ((map (make-sparse-keymap))) + ;; Note that the comment character isn't set up until asm-mode is called. + (define-key map ":" 'asm-colon) + (define-key map "\C-c;" 'comment-region) + (define-key map "\C-j" 'newline-and-indent) + (define-key map "\C-m" 'newline-and-indent) + map) + "Keymap for Asm mode.") + +(defconst asm-font-lock-keywords + '(("^\\(\\(\\sw\\|\\s_\\)+\\)\\>:?[ \t]*\\(\\sw+\\(\\.\\sw+\\)*\\)?" + (1 font-lock-function-name-face) (3 font-lock-keyword-face nil t)) + ;; label started from ".". + ("^\\(\\.\\(\\sw\\|\\s_\\)+\\)\\>:" + 1 font-lock-function-name-face) + ("^\\((\\sw+)\\)?\\s +\\(\\(\\.?\\sw\\|\\s_\\)+\\(\\.\\sw+\\)*\\)" + 2 font-lock-keyword-face) + ;; directive started from ".". + ("^\\(\\.\\(\\sw\\|\\s_\\)+\\)\\>[^:]?" + 1 font-lock-keyword-face)) + "Additional expressions to highlight in Assembler mode.") ;;;###autoload (defun asm-mode () @@ -75,88 +104,88 @@ Features a private abbrev table and the following bindings: \\[asm-comment]\tsmart placement of assembler comments. The character used for making comments is set by the variable -`asm-comment-char' (which defaults to `;'). You may want to set this -appropriately for the assembler on your machine in `defaults.el'. +`asm-comment-char' (which defaults to `?\\;'). -Alternatively, you may set this variable in `asm-set-comment-hook', which is -called near the beginning of mode initialization. +Alternatively, you may set this variable in `asm-mode-set-comment-hook', +which is called near the beginning of mode initialization. -Turning on `asm-mode' calls the value of the variable `asm-mode-hook', -if that value is non-nil, at the end of initialization. +Turning on Asm mode runs the hook `asm-mode-hook' at the end of initialization. -Special commands:\\{asm-mode-map} -" +Special commands: +\\{asm-mode-map}" (interactive) (kill-all-local-variables) - (use-local-map asm-mode-map) (setq mode-name "Assembler") (setq major-mode 'asm-mode) (setq local-abbrev-table asm-mode-abbrev-table) - (make-local-variable 'asm-mode-syntax-table) - (setq asm-mode-syntax-table (make-syntax-table)) - (set-syntax-table asm-mode-syntax-table) + (make-local-variable 'font-lock-defaults) + (setq font-lock-defaults '(asm-font-lock-keywords)) + (set (make-local-variable 'indent-line-function) 'asm-indent-line) + ;; Stay closer to the old TAB behavior (was tab-to-tab-stop). + (set (make-local-variable 'tab-always-indent) nil) + (run-hooks 'asm-mode-set-comment-hook) - (modify-syntax-entry asm-comment-char - "<" asm-mode-syntax-table) - (modify-syntax-entry ?\n - ">" asm-mode-syntax-table) - (let ((cs (regexp-quote (char-to-string asm-comment-char)))) - (make-local-variable 'comment-start) - (setq comment-start (concat cs " ")) - (make-local-variable 'comment-start-skip) - (setq comment-start-skip (concat cs "+[ \t]*")) - (setq asm-inline-empty-comment-pattern (concat "^.+" cs "+ *$")) - (setq asm-code-level-empty-comment-pattern (concat "^[\t ]+" cs cs " *$")) - (setq asm-flush-left-empty-comment-pattern (concat "^" cs cs cs " *$")) - ) + ;; Make our own local child of asm-mode-map + ;; so we can define our own comment character. + (use-local-map (nconc (make-sparse-keymap) asm-mode-map)) + (local-set-key (vector asm-comment-char) 'asm-comment) + (set-syntax-table (make-syntax-table asm-mode-syntax-table)) + (modify-syntax-entry asm-comment-char "<") + + (make-local-variable 'comment-start) + (setq comment-start (string asm-comment-char)) + (make-local-variable 'comment-add) + (setq comment-add 1) + (make-local-variable 'comment-start-skip) + (setq comment-start-skip "\\(?:\\s<+\\|/\\*+\\)[ \t]*") + (make-local-variable 'comment-end-skip) + (setq comment-end-skip "[ \t]*\\(\\s>\\|\\*+/\\)") (make-local-variable 'comment-end) (setq comment-end "") - (make-local-variable 'comment-column) - (setq comment-column 32) - (auto-fill-mode 1) (setq fill-prefix "\t") - (run-hooks 'asm-mode-hook) - ) + (run-mode-hooks 'asm-mode-hook)) + +(defun asm-indent-line () + "Auto-indent the current line." + (interactive) + (let* ((savep (point)) + (indent (condition-case nil + (save-excursion + (forward-line 0) + (skip-chars-forward " \t") + (if (>= (point) savep) (setq savep nil)) + (max (asm-calculate-indentation) 0)) + (error 0)))) + (if savep + (save-excursion (indent-line-to indent)) + (indent-line-to indent)))) + +(defun asm-calculate-indentation () + (or + ;; Flush labels to the left margin. + (and (looking-at "\\(\\sw\\|\\s_\\)+:") 0) + ;; Same thing for `;;;' comments. + (and (looking-at "\\s<\\s<\\s<") 0) + ;; Simple `;' comments go to the comment-column. + (and (looking-at "\\s<\\(\\S<\\|\\'\\)") comment-column) + ;; The rest goes at the first tab stop. + (or (car tab-stop-list) tab-width))) - (defun asm-colon () "Insert a colon; if it follows a label, delete the label's indentation." (interactive) - (save-excursion - (beginning-of-line) - (if (looking-at "[ \t]+\\(\\sw\\|\\s_\\)+$") - (delete-horizontal-space))) - (insert ":") - (tab-to-tab-stop) - ) - -(defun asm-newline () - "Insert LFD + fill-prefix, to bring us back to code-indent level." - (interactive) - (if (eolp) (delete-horizontal-space)) - (insert "\n") - (tab-to-tab-stop) - ) - -(defun asm-line-matches (pattern &optional withcomment) - (save-excursion - (beginning-of-line) - (looking-at pattern))) - -(defun asm-pop-comment-level () - ;; Delete an empty comment ending current line. Then set up for a new one, - ;; on the current line if it was all comment, otherwise above it - (end-of-line) - (delete-horizontal-space) - (while (= (preceding-char) asm-comment-char) - (delete-backward-char 1)) - (delete-horizontal-space) - (if (bolp) - nil - (beginning-of-line) - (open-line 1)) - ) - + (let ((labelp nil)) + (save-excursion + (skip-syntax-backward "w_") + (skip-syntax-backward " ") + (if (setq labelp (bolp)) (delete-horizontal-space))) + (call-interactively 'self-insert-command) + (when labelp + (delete-horizontal-space) + (tab-to-tab-stop)))) + +;; Obsolete since Emacs-21.4. +(defalias 'asm-newline 'newline-and-indent) (defun asm-comment () "Convert an empty comment to a `larger' kind, or start a new one. @@ -169,41 +198,45 @@ These are the known comment classes: Suggested usage: while writing your code, trigger asm-comment repeatedly until you are satisfied with the kind of comment." (interactive) + (comment-normalize-vars) + (let (comempty comment) + (save-excursion + (beginning-of-line) + (setq comment (comment-search-forward (line-end-position) t)) + (setq comempty (looking-at "[ \t]*$"))) + (cond ;; Blank line? Then start comment at code indent level. - ((asm-line-matches "^[ \t]*$") - (delete-horizontal-space) - (tab-to-tab-stop) - (insert asm-comment-char comment-start)) - - ;; Nonblank line with no comment chars in it? - ;; Then start a comment at the current comment column - ((asm-line-matches (format "^[^%c]+$" asm-comment-char)) + ;; Just like `comment-dwim'. -stef + ((save-excursion (beginning-of-line) (looking-at "^[ \t]*$")) + (indent-according-to-mode) + (insert asm-comment-char asm-comment-char ?\ )) + + ;; Nonblank line w/o comment => start a comment at comment-column. + ;; Also: point before the comment => jump inside. + ((or (null comment) (< (point) comment)) (indent-for-comment)) - ;; Flush-left comment present? Just insert character. - ((asm-line-matches asm-flush-left-empty-comment-pattern) + ;; Flush-left or non-empty comment present => just insert character. + ((or (not comempty) (save-excursion (goto-char comment) (bolp))) (insert asm-comment-char)) - ;; Empty code-level comment already present? - ;; Then start flush-left comment, on line above if this one is nonempty. - ((asm-line-matches asm-code-level-empty-comment-pattern) - (asm-pop-comment-level) - (insert asm-comment-char asm-comment-char comment-start)) - - ;; Empty comment ends line? - ;; Then make code-level comment, on line above if this one is nonempty. - ((asm-line-matches asm-inline-empty-comment-pattern) - (asm-pop-comment-level) - (tab-to-tab-stop) - (insert asm-comment-char comment-start)) + ;; Empty code-level comment => upgrade to next comment level. + ((save-excursion (goto-char comment) (skip-chars-backward " \t") (bolp)) + (goto-char comment) + (insert asm-comment-char) + (indent-for-comment)) - ;; If all else fails, insert character + ;; Empty comment ends non-empty code line => new comment above. (t - (insert asm-comment-char)) + (goto-char comment) + (skip-chars-backward " \t") + (delete-region (point) (line-end-position)) + (beginning-of-line) (insert "\n") (backward-char) + (asm-comment))))) - ) - (end-of-line)) +(provide 'asm-mode) +;;; arch-tag: 210e695f-f338-4376-8913-a4c5c72ac848 ;;; asm-mode.el ends here