Add 2010 to copyright years.
[bpt/emacs.git] / lisp / progmodes / m4-mode.el
index a76c5ad..07b6656 100644 (file)
@@ -1,17 +1,18 @@
 ;;; m4-mode.el --- m4 code editing commands for Emacs
 
-;;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
+;; Free Software Foundation, Inc.
 
-;; Author: Andrew Csillag <drew@staff.prodigy.com>
-;; Maintainer: Andrew Csillag <drew@staff.prodigy.com>
+;; Author: Andrew Csillag <drew_csillag@geocities.com>
+;; Maintainer: Andrew Csillag <drew_csillag@geocities.com>
 ;; Keywords: languages, faces
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; 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, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
-;; A smart editing mode for m4 macro definitions.  It seems to have most of the 
+;; A smart editing mode for m4 macro definitions.  It seems to have most of the
 ;; syntax right (sexp motion commands work, but function motion commands don't).
 ;; It also sets the font-lock syntax stuff for colorization
 
 ;; * want to make m4-m4-(buffer|region) look sorta like M-x compile look&feel ?
 ;; * sexp motion commands don't seem to work right
 
-;; to autoload m4 lisp code:  
-;; (autoload 'm4-mode "m4-mode" nil t)
-;;
-;; or can use (load "m4-mode") or (require 'm4-mode) to just load it 
-;;
-;; to try to "auto-detect" m4 files:
-;; (setq auto-mode-alist 
-;;      (cons '(".*\\.m4$" . m4-mode)
-;;            auto-mode-alist))
-;;; Thanks: 
+;;; Thanks:
 ;;;         to Akim Demaille and Terry Jones for the bug reports
 ;;;         to Simon Marshall for the regexp tip
 ;;;         to Martin Buchholz for some general fixes
 
 ;;; Code:
 
-(defvar m4-program 
-  (cond 
+(defgroup m4 nil
+  "m4 code editing commands for Emacs."
+  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
+  :prefix "m4-"
+  :group 'languages)
+
+(defcustom m4-program
+  (cond
    ((file-exists-p "/usr/local/bin/m4") "/usr/local/bin/m4")
    ((file-exists-p "/usr/bin/m4") "/usr/bin/m4")
    ((file-exists-p "/bin/m4") "/bin/m4")
    ((file-exists-p "/usr/ccs/bin/m4") "/usr/ccs/bin/m4")
+   ( t "m4")
    )
-  "File name of the m4 executable.")
+  "File name of the m4 executable."
+  :type 'file
+  :group 'm4)
 
 ;;options to m4
-(defconst m4-program-options nil)
+(defcustom m4-program-options nil
+  "Options to pass to `m4-program'."
+  :type '(repeat string)
+  :group 'm4)
+
 ;;to use --prefix-builtins, you can use
 ;;(defconst m4-program-options '("-P"))
 ;;or
     ("\\\$\\\@" . font-lock-variable-name-face)
     ("\\\$\\\*" . font-lock-variable-name-face)
     ("\\b\\(builtin\\|change\\(com\\|quote\\|word\\)\\|d\\(e\\(bug\\(file\\|mode\\)\\|cr\\|f\\(ine\\|n\\)\\)\\|iv\\(ert\\|num\\)\\|nl\\|umpdef\\)\\|e\\(rrprint\\|syscmd\\|val\\)\\|f\\(ile\\|ormat\\)\\|gnu\\|i\\(f\\(def\\|else\\)\\|n\\(c\\(lude\\|r\\)\\|d\\(ex\\|ir\\)\\)\\)\\|l\\(en\\|ine\\)\\|m\\(4\\(exit\\|wrap\\)\\|aketemp\\)\\|p\\(atsubst\\|opdef\\|ushdef\\)\\|regexp\\|s\\(hift\\|include\\|ubstr\\|ys\\(cmd\\|val\\)\\)\\|tra\\(ceo\\(ff\\|n\\)\\|nslit\\)\\|un\\(d\\(efine\\|ivert\\)\\|ix\\)\\)\\b" . font-lock-keyword-face)
-    ("\\b\\(m4_\\(builtin\\|change\\(com\\|quote\\|word\\)\\|d\\(e\\(bug\\(file\\|mode\\)\\|cr\\|f\\(ine\\|n\\)\\)\\|iv\\(ert\\|num\\)\\|nl\\|umpdef\\)\\|e\\(rrprint\\|syscmd\\|val\\)\\|f\\(ile\\|ormat\\)\\|i\\(f\\(def\\|else\\)\\|n\\(c\\(lude\\|r\\)\\|d\\(ex\\|ir\\)\\)\\)\\|l\\(en\\|ine\\)\\|m\\(4\\(_undefine\\|exit\\|wrap\\)\\|aketemp\\)\\|p\\(atsubst\\|opdef\\|ushdef\\)\\|regexp\\|s\\(hift\\|include\\|ubstr\\|ys\\(cmd\\|val\\)\\)\\|tra\\(ceo\\(ff\\|n\\)\\|nslit\\)\\|undivert\\)\\)\\b" . font-lock-keyword-face)
-    "Default font-lock-keywords for m4 mode.")
-)
+    ("\\b\\(m4_\\(builtin\\|change\\(com\\|quote\\|word\\)\\|d\\(e\\(bug\\(file\\|mode\\)\\|cr\\|f\\(ine\\|n\\)\\)\\|iv\\(ert\\|num\\)\\|nl\\|umpdef\\)\\|e\\(rrprint\\|syscmd\\|val\\)\\|f\\(ile\\|ormat\\)\\|i\\(f\\(def\\|else\\)\\|n\\(c\\(lude\\|r\\)\\|d\\(ex\\|ir\\)\\)\\)\\|l\\(en\\|ine\\)\\|m\\(4\\(_undefine\\|exit\\|wrap\\)\\|aketemp\\)\\|p\\(atsubst\\|opdef\\|ushdef\\)\\|regexp\\|s\\(hift\\|include\\|ubstr\\|ys\\(cmd\\|val\\)\\)\\|tra\\(ceo\\(ff\\|n\\)\\|nslit\\)\\|undivert\\)\\)\\b" . font-lock-keyword-face))
+  "Default font-lock-keywords for `m4 mode'.")
+
+(defcustom m4-mode-hook nil
+  "*Hook called by `m4-mode'."
+  :type 'hook
+  :group 'm4)
 
 ;;this may still need some work
 (defvar m4-mode-syntax-table nil
-  "syntax table used in m4 mode")
+  "Syntax table used while in `m4-mode'.")
 (setq m4-mode-syntax-table (make-syntax-table))
 (modify-syntax-entry ?` "('" m4-mode-syntax-table)
 (modify-syntax-entry ?' ")`" m4-mode-syntax-table)
 (modify-syntax-entry ?\"  "w" m4-mode-syntax-table)
 
 (defvar m4-mode-map
-  (let ((map (make-sparse-keymap)))
+  (let ((map (make-sparse-keymap))
+       (menu-map (make-sparse-keymap)))
     (define-key map "\C-c\C-b" 'm4-m4-buffer)
     (define-key map "\C-c\C-r" 'm4-m4-region)
     (define-key map "\C-c\C-c" 'comment-region)
+    (define-key map [menu-bar m4-mode] (cons "M4" menu-map))
+    (define-key menu-map [m4c]
+      '(menu-item "Comment Region" comment-region
+                 :help "Comment Region"))
+    (define-key menu-map [m4b]
+      '(menu-item "M4 Buffer" m4-m4-buffer
+                 :help "Send contents of the current buffer to m4"))
+    (define-key menu-map [m4r]
+      '(menu-item "M4 Region" m4-m4-region
+                 :help "Send contents of the current region to m4"))
     map))
 
-(defun m4-end-m4 (process event)
-  (cond ((equal event "kill\n") (princ "m4 process done"))
-       (t (princ
-           (format "Process: %s had the event `%s'" process event)))))
+(defvar m4-mode-abbrev-table nil
+  "Abbrev table used while in `m4-mode'.")
 
-(defun m4-start-m4 ()
-  (eval (append (append '(start-process "m4process" "*m4 output*" m4-program)
-               m4-program-options) '("-e")))
-  (set-process-sentinel (get-process "m4process") 'm4-end-m4))
+(unless m4-mode-abbrev-table
+  (define-abbrev-table 'm4-mode-abbrev-table ()))
 
 (defun m4-m4-buffer ()
-  "send contents of the current buffer to m4"
+  "Send contents of the current buffer to m4."
   (interactive)
-  (m4-start-m4)
-  (process-send-region "m4process" (point-min) (point-max))
-  (process-send-eof "m4process")
-  (switch-to-buffer-other-window "*m4 output*")
-  (delete-process "m4process"))
-
+  (shell-command-on-region
+   (point-min) (point-max)
+   (mapconcat 'identity (cons m4-program m4-program-options) "\s")
+   "*m4-output*" nil)
+  (switch-to-buffer-other-window "*m4-output*"))
 
 (defun m4-m4-region ()
-  "send contents of the current region to m4"
+  "Send contents of the current region to m4."
   (interactive)
-  (m4-start-m4)
-  (process-send-region "m4process" (point) (mark))
-  (process-send-eof "m4process")
-  (switch-to-buffer-other-window "*m4 output*"))
+  (shell-command-on-region
+   (point) (mark)
+   (mapconcat 'identity (cons m4-program m4-program-options) "\s")
+   "*m4-output*" nil)
+  (switch-to-buffer-other-window "*m4-output*"))
 
+;;;###autoload
 (defun m4-mode ()
-  "A major-mode to edit m4 macro files
+  "A major mode to edit m4 macro files.
 \\{m4-mode-map}
 "
   (interactive)
   (setq comment-start "#")
   (make-local-variable 'parse-sexp-ignore-comments)
   (setq parse-sexp-ignore-comments t)
+  (setq local-abbrev-table m4-mode-abbrev-table)
 
-
-  (make-local-variable 'font-lock-defaults)  
+  (make-local-variable 'font-lock-defaults)
   (setq major-mode 'm4-mode
        mode-name "m4"
        font-lock-defaults '(m4-font-lock-keywords nil)
        )
   (set-syntax-table m4-mode-syntax-table)
-  (run-hooks 'm4-mode-hook))
+  (run-mode-hooks 'm4-mode-hook))
 
 (provide 'm4-mode)
 ;;stuff to play with for debugging
 ;(char-to-string (char-syntax ?`))
 
 ;;;how I generate the nasty looking regexps at the top
-;;;(make-regexp '("builtin" "changecom" "changequote" "changeword" "debugfile" 
-;;;              "debugmode" "decr" "define" "defn" "divert" "divnum" "dnl" 
+;;;(make-regexp '("builtin" "changecom" "changequote" "changeword" "debugfile"
+;;;              "debugmode" "decr" "define" "defn" "divert" "divnum" "dnl"
 ;;;              "dumpdef" "errprint" "esyscmd" "eval" "file" "format" "gnu"
-;;;              "ifdef" "ifelse" "include" "incr" "index" "indir" "len" "line" 
-;;;              "m4exit" "m4wrap" "maketemp" "patsubst" "popdef" "pushdef" "regexp" 
-;;;              "shift" "sinclude" "substr" "syscmd" "sysval" "traceoff" "traceon" 
+;;;              "ifdef" "ifelse" "include" "incr" "index" "indir" "len" "line"
+;;;              "m4exit" "m4wrap" "maketemp" "patsubst" "popdef" "pushdef" "regexp"
+;;;              "shift" "sinclude" "substr" "syscmd" "sysval" "traceoff" "traceon"
 ;;;              "translit" "undefine" "undivert" "unix"))
-;;;(make-regexp '("m4_builtin" "m4_changecom" "m4_changequote" "m4_changeword" 
-;;;              "m4_debugfile" "m4_debugmode" "m4_decr" "m4_define" "m4_defn" 
-;;;              "m4_divert" "m4_divnum" "m4_dnl" "m4_dumpdef" "m4_errprint" 
-;;;              "m4_esyscmd" "m4_eval" "m4_file" "m4_format" "m4_ifdef" "m4_ifelse" 
-;;;              "m4_include" "m4_incr" "m4_index" "m4_indir" "m4_len" "m4_line" 
-;;;              "m4_m4exit" "m4_m4wrap" "m4_maketemp" "m4_patsubst" "m4_popdef" 
-;;;              "m4_pushdef" "m4_regexp" "m4_shift" "m4_sinclude" "m4_substr" 
-;;;              "m4_syscmd" "m4_sysval" "m4_traceoff" "m4_traceon" "m4_translit" 
+;;;(make-regexp '("m4_builtin" "m4_changecom" "m4_changequote" "m4_changeword"
+;;;              "m4_debugfile" "m4_debugmode" "m4_decr" "m4_define" "m4_defn"
+;;;              "m4_divert" "m4_divnum" "m4_dnl" "m4_dumpdef" "m4_errprint"
+;;;              "m4_esyscmd" "m4_eval" "m4_file" "m4_format" "m4_ifdef" "m4_ifelse"
+;;;              "m4_include" "m4_incr" "m4_index" "m4_indir" "m4_len" "m4_line"
+;;;              "m4_m4exit" "m4_m4wrap" "m4_maketemp" "m4_patsubst" "m4_popdef"
+;;;              "m4_pushdef" "m4_regexp" "m4_shift" "m4_sinclude" "m4_substr"
+;;;              "m4_syscmd" "m4_sysval" "m4_traceoff" "m4_traceon" "m4_translit"
 ;;;              "m4_m4_undefine" "m4_undivert"))
 
-;;; m4.el ends here
+;; arch-tag: 87811d86-94c1-474b-9666-587f6da74af1
+;;; m4-mode.el ends here