;;; m4-mode.el --- m4 code editing commands for Emacs ;; Author: Andrew Csillag (drew@staff.prodigy.com) ;; Maintainer: Andrew Csillag (drew@staff.prodigy.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., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, 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 ;; By Drew Csillag (drew@staff.prodigy.com) ;; $Id: m4-mode.el,v 1.3 2003-06-07 12:14:44 adrian Exp $ ;; History: ;; Date Version Who Action ;; -------- ------- --- ---- ;; 09/13/96 1.0 DC Created ;; 09/26/96 1.1 DC added syntax table stuff so now matches `'s ;; now can use C-c C-b to m4 on buffer,C-c C-r for region ;; added m4-comment-region (C-c C-c) ;; 09/27/96 1.2 DC Redid header comment ;; 1.3 DC more cosmetic fixes ;; 1.4 DC removed m4-comment-region, using comment-region instead ;; 10/03/96 DC added provide line ;; 10/24/96 1.5 DC fixed keyword regexp ;; 10/29/96 1.6 DC added m4_keywords for --prefix-builtins ;; fixed syntax table so _define_ isn't keywordified ;; 10/29/96 1.8 DC fixed a problem where comments go fontified incorrectly ;; if they had quotes in them ;; 11/21/96 1.9 DC collapsed 4 regexps into 1 and removed a duplicate, ;; removed a duplicate backslash ;; 05/16/97 1.10 DC added contributed fixes and enhancements from ;; Martin Buchholz ;; Can now specify options to m4 via m4-program-options ;; Now terminates m4 processes when the buffer send is ;; done ;; dnl and m4_dnl recognized as comment starters ;; 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 ;; 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: ;;; 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: ;;path to the m4 program (defvar 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") ) ) ;;options to m4 (defconst m4-program-options nil) ;;to use --prefix-builtins, you can use ;;(defconst m4-program-options '("-P")) ;;or ;;(defconst m4-program-options '("--prefix-builtins")) ;;thank god for make-regexp.el! (defvar m4-font-lock-keywords `( ("\\(\\bdnl\\b\\|\\bm4_dnl\\b\\|^\\#\\).*$" . font-lock-comment-face) ("\\$[*#@0-9]" . 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") ) ;;this may still need some work (defvar m4-mode-syntax-table nil "syntax table used 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 ?* "." 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))) (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)) (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))))) (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) ) (defun m4-m4-buffer () "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") ) (defun m4-m4-region () "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*") ) ;;;###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) (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)) ;; XEmacs additions ;; APA: autoconf-mode is XEmacs' preferred m4 mode, see its autoload ;; cookie. ;; ;;;###autoload(add-to-list 'auto-mode-alist '(".*\\.m4$" . m4-mode)) (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"))