lisp/progmodes/autoconf.el

   1 ;;; autoconf.el --- mode for editing Autoconf configure.in files
   2
   3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   4 ;; Free Software Foundation, Inc.
   5
   6 ;; Author: Dave Love <fx@gnu.org>
   7 ;; Keywords: languages
   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 3 of the License, or
  14 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Provides fairly minimal font-lock, imenu and indentation support
  27 ;; for editing configure.in files.  Only Autoconf syntax is processed.
  28 ;; There is no attempt to deal with shell text -- probably that will
  29 ;; always lose.
  30
  31 ;; This is specialized for configure.in files.  It doesn't inherit the
  32 ;; general M4 stuff from M4 mode.
  33
  34 ;; There is also an autoconf-mode.el in existence.  That appears to be
  35 ;; for editing the Autoconf M4 source, rather than configure.in files.
  36
  37 ;;; Code:
  38
  39 (defvar font-lock-syntactic-keywords)
  40
  41 (defvar autoconf-mode-map (make-sparse-keymap))
  42
  43 (defvar autoconf-mode-hook nil
  44   "Hook run by `autoconf-mode'.")
  45
  46 (defconst autoconf-font-lock-syntactic-keywords
  47   '(("\\<dnl\\>" 0 '(11))))
  48
  49 (defconst autoconf-definition-regexp
  50   "AC_\\(SUBST\\|DEFINE\\(_UNQUOTED\\)?\\)(\\[*\\(\\sw+\\)\\]*")
  51
  52 (defvar autoconf-font-lock-keywords
  53   `(("\\_<A[CHMS]_\\sw+" . font-lock-keyword-face)
  54     (,autoconf-definition-regexp
  55      3 font-lock-function-name-face)
  56     ;; Are any other M4 keywords really appropriate for configure.in,
  57     ;; given that we do `dnl'?
  58     ("changequote" . font-lock-keyword-face)))
  59
  60 (defvar autoconf-mode-syntax-table
  61   (let ((table (make-syntax-table)))
  62     (modify-syntax-entry ?\" "." table)
  63     (modify-syntax-entry ?\n ">" table)
  64     (modify-syntax-entry ?# "<" table)
  65     table))
  66
  67 (defvar autoconf-imenu-generic-expression
  68   (list (list nil autoconf-definition-regexp 3)))
  69
  70 ;; It's not clear how best to implement this.
  71 (defun autoconf-current-defun-function ()
  72   "Function to use for `add-log-current-defun-function' in Autoconf mode.
  73 This version looks back for an AC_DEFINE or AC_SUBST.  It will stop
  74 searching backwards at another AC_... command."
  75   (save-excursion
  76     (with-syntax-table (copy-syntax-table autoconf-mode-syntax-table)
  77       (modify-syntax-entry ?_ "w")
  78       (if (re-search-backward autoconf-definition-regexp
  79                               (save-excursion (beginning-of-defun) (point))
  80                               t)
  81           (match-string-no-properties 3)))))
  82
  83 ;;;###autoload
  84 (defun autoconf-mode ()
  85   "Major mode for editing Autoconf configure.in files."
  86   (interactive)
  87   (kill-all-local-variables)
  88   (use-local-map autoconf-mode-map)
  89   (setq major-mode 'autoconf-mode)
  90   (setq mode-name "Autoconf")
  91   (set-syntax-table autoconf-mode-syntax-table)
  92   (set (make-local-variable 'parens-require-spaces) nil) ; for M4 arg lists
  93   (set (make-local-variable 'defun-prompt-regexp)
  94        "^[ \t]*A[CM]_\\(\\sw\\|\\s_\\)+")
  95   (set (make-local-variable 'comment-start) "dnl ")
  96   (set (make-local-variable 'comment-start-skip) "\\(?:\\<dnl\\|#\\) +")
  97   (set (make-local-variable 'font-lock-syntactic-keywords)
  98        autoconf-font-lock-syntactic-keywords)
  99   (set (make-local-variable 'font-lock-defaults)
 100        `(autoconf-font-lock-keywords nil nil (("_" . "w"))))
 101   (set (make-local-variable 'imenu-generic-expression)
 102        autoconf-imenu-generic-expression)
 103   (set (make-local-variable 'imenu-syntax-alist) '(("_" . "w")))
 104   (set (make-local-variable 'indent-line-function) #'indent-relative)
 105   (set (make-local-variable 'add-log-current-defun-function)
 106         #'autoconf-current-defun-function)
 107   (run-mode-hooks 'autoconf-mode-hook))
 108
 109 (provide 'autoconf-mode)
 110 (provide 'autoconf)
 111
 112 ;; arch-tag: 4f44778f-2ab3-49a1-a103-f0acb9df2de4
 113 ;;; autoconf.el ends here