[bpt/emacs.git] / lisp / progmodes / m4-mode.el

;;; m4-mode.el --- m4 code editing commands for Emacs

;; Copyright (C) 1996, 1997, 2001, 2002, 2003, 2004, 2005
;; Free Software Foundation, Inc.

;; 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
;; 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.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; 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

;; To Do's:

;; * want to make m4-m4-(buffer|region) look sorta like M-x compile look&feel ?
;; * sexp motion commands don't seem to work right

;;; 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:

(defgroup m4 nil
  "m4 code editing commands for Emacs."
  :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."
  :type 'file
  :group 'm4)

;;options to m4
(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
;;(defconst m4-program-options '("--prefix-builtins"))

(defvar m4-font-lock-keywords
  `(
    ("\\(\\b\\(m4_\\)?dnl\\b\\|^\\#\\).*$" . font-lock-comment-face)
;    ("\\(\\bdnl\\b\\|\\bm4_dnl\\b\\|^\\#\\).*$" . font-lock-comment-face)
    ("\\$[*#@0-9]" . font-lock-variable-name-face)
    ("\\\$\\\@" . 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'.")

(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 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 ?# "<\n" m4-mode-syntax-table)
(modify-syntax-entry ?\n ">#" m4-mode-syntax-table)
(modify-syntax-entry ?{  "_" m4-mode-syntax-table)
(modify-syntax-entry ?}  "_" m4-mode-syntax-table)
(modify-syntax-entry ?*  "w" m4-mode-syntax-table)
(modify-syntax-entry ?_  "w" m4-mode-syntax-table)
(modify-syntax-entry ?\"  "w" m4-mode-syntax-table)
(modify-syntax-entry ?\"  "w" m4-mode-syntax-table)

(defvar m4-mode-map
  (let ((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)
    map))

(defvar m4-mode-abbrev-table nil
  "Abbrev table used while in `m4-mode'.")

(unless m4-mode-abbrev-table
  (define-abbrev-table 'm4-mode-abbrev-table ()))

(defun m4-m4-buffer ()
  "Send contents of the current buffer to m4."
  (interactive)
  (shell-command-on-region (point-min) (point-max) m4-program "*m4-output*"
			   nil)
  (switch-to-buffer-other-window "*m4-output*"))

(defun m4-m4-region ()
  "Send contents of the current region to m4."
  (interactive)
  (shell-command-on-region (point) (mark) m4-program "*m4-output*" nil)
  (switch-to-buffer-other-window "*m4-output*"))

;;;###autoload
(defun m4-mode ()
  "A major mode to edit m4 macro files.
\\{m4-mode-map}
"
  (interactive)
  (kill-all-local-variables)
  (use-local-map m4-mode-map)

  (make-local-variable 'comment-start)
  (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)
  (setq major-mode 'm4-mode
	mode-name "m4"
	font-lock-defaults '(m4-font-lock-keywords nil)
	)
  (set-syntax-table m4-mode-syntax-table)
  (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"
;;;		  "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"
;;;		  "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"
;;;		  "m4_m4_undefine" "m4_undivert"))

;;; arch-tag: 87811d86-94c1-474b-9666-587f6da74af1
;;; m4-mode.el ends here
Commit	Line	Data
0e8ab974 RS	1	;;; m4-mode.el --- m4 code editing commands for Emacs
0e8ab974 RS	2
034babe1 NR	3	;; Copyright (C) 1996, 1997, 2001, 2002, 2003, 2004, 2005
034babe1 NR	4	;; Free Software Foundation, Inc.
0e8ab974	5
85d27e9b RS	6	;; Author: Andrew Csillag <drew_csillag@geocities.com>
85d27e9b RS	7	;; Maintainer: Andrew Csillag <drew_csillag@geocities.com>
0e8ab974 RS	8	;; Keywords: languages, faces
	9
	10	;; This file is part of GNU Emacs.
	11
	12	;; GNU Emacs is free software; you can redistribute it and/or modify
	13	;; it under the terms of the GNU General Public License as published by
	14	;; the Free Software Foundation; either version 2, or (at your option)
	15	;; any later version.
	16
	17	;; GNU Emacs is distributed in the hope that it will be useful,
	18	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	;; GNU General Public License for more details.
	21
	22	;; You should have received a copy of the GNU General Public License
	23	;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56 LK	24	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
3a35cf56 LK	25	;; Boston, MA 02110-1301, USA.
0e8ab974 RS	26
	27	;;; Commentary:
	28
6209bd8c	29	;; A smart editing mode for m4 macro definitions. It seems to have most of the
0e8ab974 RS	30	;; syntax right (sexp motion commands work, but function motion commands don't).
	31	;; It also sets the font-lock syntax stuff for colorization
	32
	33	;; To Do's:
	34
	35	;; * want to make m4-m4-(buffer\|region) look sorta like M-x compile look&feel ?
	36	;; * sexp motion commands don't seem to work right
	37
a1506d29	38	;;; Thanks:
0e8ab974	39	;;; to Akim Demaille and Terry Jones for the bug reports
9108fd3a RS	40	;;; to Simon Marshall for the regexp tip
9108fd3a RS	41	;;; to Martin Buchholz for some general fixes
0e8ab974 RS	42
	43	;;; Code:
	44
e4df16d0 SE	45	(defgroup m4 nil
	46	"m4 code editing commands for Emacs."
	47	:prefix "m4-"
	48	:group 'languages)
	49
6209bd8c JPW	50	(defcustom m4-program
6209bd8c JPW	51	(cond
9108fd3a RS	52	((file-exists-p "/usr/local/bin/m4") "/usr/local/bin/m4")
	53	((file-exists-p "/usr/bin/m4") "/usr/bin/m4")
	54	((file-exists-p "/bin/m4") "/bin/m4")
	55	((file-exists-p "/usr/ccs/bin/m4") "/usr/ccs/bin/m4")
e4df16d0	56	( t "m4")
9108fd3a	57	)
e4df16d0 SE	58	"File name of the m4 executable."
	59	:type 'file
	60	:group 'm4)
9108fd3a RS	61
9108fd3a RS	62	;;options to m4
e4df16d0 SE	63	(defcustom m4-program-options nil
	64	"Options to pass to `m4-program'."
	65	:type '(repeat string)
	66	:group 'm4)
	67
9108fd3a RS	68	;;to use --prefix-builtins, you can use
	69	;;(defconst m4-program-options '("-P"))
	70	;;or
	71	;;(defconst m4-program-options '("--prefix-builtins"))
0e8ab974	72
0e8ab974 RS	73	(defvar m4-font-lock-keywords
0e8ab974 RS	74	`(
9108fd3a RS	75	("\\(\\b\\(m4_\\)?dnl\\b\\\|^\\#\\).*$" . font-lock-comment-face)
	76	; ("\\(\\bdnl\\b\\\|\\bm4_dnl\\b\\\|^\\#\\).*$" . font-lock-comment-face)
	77	("\\$[*#@0-9]" . font-lock-variable-name-face)
0f6db76a RS	78	("\\\$\\\@" . font-lock-variable-name-face)
0f6db76a RS	79	("\\\$\\\*" . font-lock-variable-name-face)
0e8ab974	80	("\\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)
6209bd8c JPW	81	("\\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))
6209bd8c JPW	82	"Default font-lock-keywords for `m4 mode'.")
0e8ab974	83
e4df16d0 SE	84	(defcustom m4-mode-hook nil
	85	"*Hook called by `m4-mode'."
	86	:type 'hook
	87	:group 'm4)
	88
0e8ab974 RS	89	;;this may still need some work
0e8ab974 RS	90	(defvar m4-mode-syntax-table nil
6209bd8c	91	"Syntax table used while in `m4-mode'.")
0e8ab974 RS	92	(setq m4-mode-syntax-table (make-syntax-table))
	93	(modify-syntax-entry ?` "('" m4-mode-syntax-table)
	94	(modify-syntax-entry ?' ")`" m4-mode-syntax-table)
	95	(modify-syntax-entry ?# "<\n" m4-mode-syntax-table)
	96	(modify-syntax-entry ?\n ">#" m4-mode-syntax-table)
	97	(modify-syntax-entry ?{ "_" m4-mode-syntax-table)
	98	(modify-syntax-entry ?} "_" m4-mode-syntax-table)
	99	(modify-syntax-entry ?* "w" m4-mode-syntax-table)
	100	(modify-syntax-entry ?_ "w" m4-mode-syntax-table)
0f6db76a	101	(modify-syntax-entry ?\" "w" m4-mode-syntax-table)
9108fd3a	102	(modify-syntax-entry ?\" "w" m4-mode-syntax-table)
0e8ab974 RS	103
	104	(defvar m4-mode-map
	105	(let ((map (make-sparse-keymap)))
	106	(define-key map "\C-c\C-b" 'm4-m4-buffer)
	107	(define-key map "\C-c\C-r" 'm4-m4-region)
	108	(define-key map "\C-c\C-c" 'comment-region)
	109	map))
	110
dfdbf5b6	111	(defvar m4-mode-abbrev-table nil
6209bd8c	112	"Abbrev table used while in `m4-mode'.")
dfdbf5b6 GM	113
	114	(unless m4-mode-abbrev-table
	115	(define-abbrev-table 'm4-mode-abbrev-table ()))
	116
0e8ab974	117	(defun m4-m4-buffer ()
6209bd8c	118	"Send contents of the current buffer to m4."
0e8ab974	119	(interactive)
5119b7a7 RS	120	(shell-command-on-region (point-min) (point-max) m4-program "m4-output"
	121	nil)
	122	(switch-to-buffer-other-window "m4-output"))
0e8ab974 RS	123
0e8ab974 RS	124	(defun m4-m4-region ()
6209bd8c	125	"Send contents of the current region to m4."
0e8ab974	126	(interactive)
5119b7a7 RS	127	(shell-command-on-region (point) (mark) m4-program "m4-output" nil)
5119b7a7 RS	128	(switch-to-buffer-other-window "m4-output"))
0e8ab974	129
10918533	130	;;;###autoload
0e8ab974	131	(defun m4-mode ()
10918533	132	"A major mode to edit m4 macro files.
0e8ab974 RS	133	\\{m4-mode-map}
	134	"
	135	(interactive)
	136	(kill-all-local-variables)
	137	(use-local-map m4-mode-map)
	138
	139	(make-local-variable 'comment-start)
	140	(setq comment-start "#")
	141	(make-local-variable 'parse-sexp-ignore-comments)
	142	(setq parse-sexp-ignore-comments t)
dfdbf5b6	143	(setq local-abbrev-table m4-mode-abbrev-table)
0e8ab974	144
6209bd8c	145	(make-local-variable 'font-lock-defaults)
0e8ab974 RS	146	(setq major-mode 'm4-mode
0e8ab974 RS	147	mode-name "m4"
9108fd3a	148	font-lock-defaults '(m4-font-lock-keywords nil)
0e8ab974 RS	149	)
0e8ab974 RS	150	(set-syntax-table m4-mode-syntax-table)
9a969196	151	(run-mode-hooks 'm4-mode-hook))
0e8ab974 RS	152
	153	(provide 'm4-mode)
	154	;;stuff to play with for debugging
	155	;(char-to-string (char-syntax ?`))
	156
	157	;;;how I generate the nasty looking regexps at the top
a1506d29 JB	158	;;;(make-regexp '("builtin" "changecom" "changequote" "changeword" "debugfile"
a1506d29 JB	159	;;; "debugmode" "decr" "define" "defn" "divert" "divnum" "dnl"
0e8ab974	160	;;; "dumpdef" "errprint" "esyscmd" "eval" "file" "format" "gnu"
a1506d29 JB	161	;;; "ifdef" "ifelse" "include" "incr" "index" "indir" "len" "line"
	162	;;; "m4exit" "m4wrap" "maketemp" "patsubst" "popdef" "pushdef" "regexp"
	163	;;; "shift" "sinclude" "substr" "syscmd" "sysval" "traceoff" "traceon"
0e8ab974	164	;;; "translit" "undefine" "undivert" "unix"))
a1506d29 JB	165	;;;(make-regexp '("m4_builtin" "m4_changecom" "m4_changequote" "m4_changeword"
	166	;;; "m4_debugfile" "m4_debugmode" "m4_decr" "m4_define" "m4_defn"
	167	;;; "m4_divert" "m4_divnum" "m4_dnl" "m4_dumpdef" "m4_errprint"
	168	;;; "m4_esyscmd" "m4_eval" "m4_file" "m4_format" "m4_ifdef" "m4_ifelse"
	169	;;; "m4_include" "m4_incr" "m4_index" "m4_indir" "m4_len" "m4_line"
	170	;;; "m4_m4exit" "m4_m4wrap" "m4_maketemp" "m4_patsubst" "m4_popdef"
	171	;;; "m4_pushdef" "m4_regexp" "m4_shift" "m4_sinclude" "m4_substr"
	172	;;; "m4_syscmd" "m4_sysval" "m4_traceoff" "m4_traceon" "m4_translit"
0e8ab974 RS	173	;;; "m4_m4_undefine" "m4_undivert"))
0e8ab974 RS	174
ab5796a9	175	;;; arch-tag: 87811d86-94c1-474b-9666-587f6da74af1
e8af40ee	176	;;; m4-mode.el ends here