code.delx.au - gnu-emacs/blob - lisp/progmodes/m4-mode.el

   1 ;;; m4-mode.el --- m4 code editing commands for Emacs
   2
   3 ;;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
   4
   5 ;; Author: Andrew Csillag <drew@staff.prodigy.com>
   6 ;; Maintainer: Andrew Csillag <drew@staff.prodigy.com>
   7 ;; Keywords: languages, faces
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  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
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; A smart editing mode for m4 macro definitions.  It seems to have most of the
  29 ;; syntax right (sexp motion commands work, but function motion commands don't).
  30 ;; It also sets the font-lock syntax stuff for colorization
  31
  32 ;; To Do's:
  33
  34 ;; * want to make m4-m4-(buffer|region) look sorta like M-x compile look&feel ?
  35 ;; * sexp motion commands don't seem to work right
  36
  37 ;; to autoload m4 lisp code:
  38 ;; (autoload 'm4-mode "m4-mode" nil t)
  39 ;;
  40 ;; or can use (load "m4-mode") or (require 'm4-mode) to just load it
  41 ;;
  42 ;; to try to "auto-detect" m4 files:
  43 ;; (setq auto-mode-alist
  44 ;;       (cons '(".*\\.m4$" . m4-mode)
  45 ;;             auto-mode-alist))
  46 ;;; Thanks:
  47 ;;;         to Akim Demaille and Terry Jones for the bug reports
  48 ;;;         to Simon Marshall for the regexp tip
  49 ;;;         to Martin Buchholz for some general fixes
  50
  51 ;;; Code:
  52
  53 (defvar m4-program
  54   (cond
  55    ((file-exists-p "/usr/local/bin/m4") "/usr/local/bin/m4")
  56    ((file-exists-p "/usr/bin/m4") "/usr/bin/m4")
  57    ((file-exists-p "/bin/m4") "/bin/m4")
  58    ((file-exists-p "/usr/ccs/bin/m4") "/usr/ccs/bin/m4")
  59    )
  60   "File name of the m4 executable.")
  61
  62 ;;options to m4
  63 (defconst m4-program-options nil)
  64 ;;to use --prefix-builtins, you can use
  65 ;;(defconst m4-program-options '("-P"))
  66 ;;or
  67 ;;(defconst m4-program-options '("--prefix-builtins"))
  68
  69 (defvar m4-font-lock-keywords
  70   `(
  71     ("\\(\\b\\(m4_\\)?dnl\\b\\|^\\#\\).*$" . font-lock-comment-face)
  72 ;    ("\\(\\bdnl\\b\\|\\bm4_dnl\\b\\|^\\#\\).*$" . font-lock-comment-face)
  73     ("\\$[*#@0-9]" . font-lock-variable-name-face)
  74     ("\\\$\\\@" . font-lock-variable-name-face)
  75     ("\\\$\\\*" . font-lock-variable-name-face)
  76     ("\\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)
  77     ("\\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)
  78     "Default font-lock-keywords for m4 mode.")
  79 )
  80
  81 ;;this may still need some work
  82 (defvar m4-mode-syntax-table nil
  83   "syntax table used in m4 mode")
  84 (setq m4-mode-syntax-table (make-syntax-table))
  85 (modify-syntax-entry ?` "('" m4-mode-syntax-table)
  86 (modify-syntax-entry ?' ")`" m4-mode-syntax-table)
  87 (modify-syntax-entry ?# "<\n" m4-mode-syntax-table)
  88 (modify-syntax-entry ?\n ">#" m4-mode-syntax-table)
  89 (modify-syntax-entry ?{  "_" m4-mode-syntax-table)
  90 (modify-syntax-entry ?}  "_" m4-mode-syntax-table)
  91 (modify-syntax-entry ?*  "w" m4-mode-syntax-table)
  92 (modify-syntax-entry ?_  "w" m4-mode-syntax-table)
  93 (modify-syntax-entry ?\"  "w" m4-mode-syntax-table)
  94 (modify-syntax-entry ?\"  "w" m4-mode-syntax-table)
  95
  96 (defvar m4-mode-map
  97   (let ((map (make-sparse-keymap)))
  98     (define-key map "\C-c\C-b" 'm4-m4-buffer)
  99     (define-key map "\C-c\C-r" 'm4-m4-region)
 100     (define-key map "\C-c\C-c" 'comment-region)
 101     map))
 102
 103 (defun m4-end-m4 (process event)
 104   (cond ((equal event "kill\n") (princ "m4 process done"))
 105         (t (princ
 106             (format "Process: %s had the event `%s'" process event)))))
 107
 108 (defun m4-start-m4 ()
 109   (eval (append (append '(start-process "m4process" "*m4 output*" m4-program)
 110                 m4-program-options) '("-e")))
 111   (set-process-sentinel (get-process "m4process") 'm4-end-m4))
 112
 113 (defun m4-m4-buffer ()
 114   "send contents of the current buffer to m4"
 115   (interactive)
 116   (m4-start-m4)
 117   (process-send-region "m4process" (point-min) (point-max))
 118   (process-send-eof "m4process")
 119   (switch-to-buffer-other-window "*m4 output*")
 120   (delete-process "m4process"))
 121
 122
 123 (defun m4-m4-region ()
 124   "send contents of the current region to m4"
 125   (interactive)
 126   (m4-start-m4)
 127   (process-send-region "m4process" (point) (mark))
 128   (process-send-eof "m4process")
 129   (switch-to-buffer-other-window "*m4 output*"))
 130
 131 (defun m4-mode ()
 132   "A major-mode to edit m4 macro files
 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)
 143
 144
 145   (make-local-variable  'font-lock-defaults)
 146   (setq major-mode 'm4-mode
 147         mode-name "m4"
 148         font-lock-defaults '(m4-font-lock-keywords nil)
 149         )
 150   (set-syntax-table m4-mode-syntax-table)
 151   (run-hooks 'm4-mode-hook))
 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
 158 ;;;(make-regexp '("builtin" "changecom" "changequote" "changeword" "debugfile"
 159 ;;;               "debugmode" "decr" "define" "defn" "divert" "divnum" "dnl"
 160 ;;;               "dumpdef" "errprint" "esyscmd" "eval" "file" "format" "gnu"
 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"
 164 ;;;               "translit" "undefine" "undivert" "unix"))
 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"
 173 ;;;               "m4_m4_undefine" "m4_undivert"))
 174
 175 ;;; m4.el ends here