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