[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, 2006, 2007, 2008, 2009, 2010
;; 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 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
;; 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.  If not, see <http://www.gnu.org/licenses/>.

;;; 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."
  :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."
  :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))
	(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))

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