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