1;;; m4-mode.el --- m4 code editing commands for Emacs
2
3;; Copyright (C) 1996, 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4;; Free Software Foundation, Inc.
5
6;; Author: Andrew Csillag <drew_csillag@geocities.com>
7;; Maintainer: Andrew Csillag <drew_csillag@geocities.com>
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
24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25;; Boston, MA 02110-1301, USA.
26
27;;; Commentary:
28
29;; A smart editing mode for m4 macro definitions.  It seems to have most of the
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
38;;; Thanks:
39;;;         to Akim Demaille and Terry Jones for the bug reports
40;;;         to Simon Marshall for the regexp tip
41;;;         to Martin Buchholz for some general fixes
42
43;;; Code:
44
45(defgroup m4 nil
46  "m4 code editing commands for Emacs."
47  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
48  :prefix "m4-"
49  :group 'languages)
50
51(defcustom m4-program
52  (cond
53   ((file-exists-p "/usr/local/bin/m4") "/usr/local/bin/m4")
54   ((file-exists-p "/usr/bin/m4") "/usr/bin/m4")
55   ((file-exists-p "/bin/m4") "/bin/m4")
56   ((file-exists-p "/usr/ccs/bin/m4") "/usr/ccs/bin/m4")
57   ( t "m4")
58   )
59  "File name of the m4 executable."
60  :type 'file
61  :group 'm4)
62
63;;options to m4
64(defcustom m4-program-options nil
65  "Options to pass to `m4-program'."
66  :type '(repeat string)
67  :group 'm4)
68
69;;to use --prefix-builtins, you can use
70;;(defconst m4-program-options '("-P"))
71;;or
72;;(defconst m4-program-options '("--prefix-builtins"))
73
74(defvar m4-font-lock-keywords
75  `(
76    ("\\(\\b\\(m4_\\)?dnl\\b\\|^\\#\\).*$" . font-lock-comment-face)
77;    ("\\(\\bdnl\\b\\|\\bm4_dnl\\b\\|^\\#\\).*$" . font-lock-comment-face)
78    ("\\$[*#@0-9]" . font-lock-variable-name-face)
79    ("\\\$\\\@" . font-lock-variable-name-face)
80    ("\\\$\\\*" . font-lock-variable-name-face)
81    ("\\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)
82    ("\\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))
83  "Default font-lock-keywords for `m4 mode'.")
84
85(defcustom m4-mode-hook nil
86  "*Hook called by `m4-mode'."
87  :type 'hook
88  :group 'm4)
89
90;;this may still need some work
91(defvar m4-mode-syntax-table nil
92  "Syntax table used while in `m4-mode'.")
93(setq m4-mode-syntax-table (make-syntax-table))
94(modify-syntax-entry ?` "('" m4-mode-syntax-table)
95(modify-syntax-entry ?' ")`" m4-mode-syntax-table)
96(modify-syntax-entry ?# "<\n" m4-mode-syntax-table)
97(modify-syntax-entry ?\n ">#" m4-mode-syntax-table)
98(modify-syntax-entry ?{  "_" m4-mode-syntax-table)
99(modify-syntax-entry ?}  "_" m4-mode-syntax-table)
100(modify-syntax-entry ?*  "w" m4-mode-syntax-table)
101(modify-syntax-entry ?_  "w" m4-mode-syntax-table)
102(modify-syntax-entry ?\"  "w" m4-mode-syntax-table)
103(modify-syntax-entry ?\"  "w" m4-mode-syntax-table)
104
105(defvar m4-mode-map
106  (let ((map (make-sparse-keymap)))
107    (define-key map "\C-c\C-b" 'm4-m4-buffer)
108    (define-key map "\C-c\C-r" 'm4-m4-region)
109    (define-key map "\C-c\C-c" 'comment-region)
110    map))
111
112(defvar m4-mode-abbrev-table nil
113  "Abbrev table used while in `m4-mode'.")
114
115(unless m4-mode-abbrev-table
116  (define-abbrev-table 'm4-mode-abbrev-table ()))
117
118(defun m4-m4-buffer ()
119  "Send contents of the current buffer to m4."
120  (interactive)
121  (shell-command-on-region
122   (point-min) (point-max)
123   (mapconcat 'identity (cons m4-program m4-program-options) "\s")
124   "*m4-output*" nil)
125  (switch-to-buffer-other-window "*m4-output*"))
126
127(defun m4-m4-region ()
128  "Send contents of the current region to m4."
129  (interactive)
130  (shell-command-on-region
131   (point) (mark)
132   (mapconcat 'identity (cons m4-program m4-program-options) "\s")
133   "*m4-output*" nil)
134  (switch-to-buffer-other-window "*m4-output*"))
135
136;;;###autoload
137(defun m4-mode ()
138  "A major mode to edit m4 macro files.
139\\{m4-mode-map}
140"
141  (interactive)
142  (kill-all-local-variables)
143  (use-local-map m4-mode-map)
144
145  (make-local-variable 'comment-start)
146  (setq comment-start "#")
147  (make-local-variable 'parse-sexp-ignore-comments)
148  (setq parse-sexp-ignore-comments t)
149  (setq local-abbrev-table m4-mode-abbrev-table)
150
151  (make-local-variable	'font-lock-defaults)
152  (setq major-mode 'm4-mode
153	mode-name "m4"
154	font-lock-defaults '(m4-font-lock-keywords nil)
155	)
156  (set-syntax-table m4-mode-syntax-table)
157  (run-mode-hooks 'm4-mode-hook))
158
159(provide 'm4-mode)
160;;stuff to play with for debugging
161;(char-to-string (char-syntax ?`))
162
163;;;how I generate the nasty looking regexps at the top
164;;;(make-regexp '("builtin" "changecom" "changequote" "changeword" "debugfile"
165;;;		  "debugmode" "decr" "define" "defn" "divert" "divnum" "dnl"
166;;;		  "dumpdef" "errprint" "esyscmd" "eval" "file" "format" "gnu"
167;;;		  "ifdef" "ifelse" "include" "incr" "index" "indir" "len" "line"
168;;;		  "m4exit" "m4wrap" "maketemp" "patsubst" "popdef" "pushdef" "regexp"
169;;;		  "shift" "sinclude" "substr" "syscmd" "sysval" "traceoff" "traceon"
170;;;		  "translit" "undefine" "undivert" "unix"))
171;;;(make-regexp '("m4_builtin" "m4_changecom" "m4_changequote" "m4_changeword"
172;;;		  "m4_debugfile" "m4_debugmode" "m4_decr" "m4_define" "m4_defn"
173;;;		  "m4_divert" "m4_divnum" "m4_dnl" "m4_dumpdef" "m4_errprint"
174;;;		  "m4_esyscmd" "m4_eval" "m4_file" "m4_format" "m4_ifdef" "m4_ifelse"
175;;;		  "m4_include" "m4_incr" "m4_index" "m4_indir" "m4_len" "m4_line"
176;;;		  "m4_m4exit" "m4_m4wrap" "m4_maketemp" "m4_patsubst" "m4_popdef"
177;;;		  "m4_pushdef" "m4_regexp" "m4_shift" "m4_sinclude" "m4_substr"
178;;;		  "m4_syscmd" "m4_sysval" "m4_traceoff" "m4_traceon" "m4_translit"
179;;;		  "m4_m4_undefine" "m4_undivert"))
180
181;;; arch-tag: 87811d86-94c1-474b-9666-587f6da74af1
182;;; m4-mode.el ends here
183