view lisp/generic.el @ 29042:09b4758f4aea

(log-edit-done): Cleanup trailing empty lines. (log-edit-insert-changelog): Drop `:' as well.

+
鐃緒申;;; generic.el --- Defining simple major modes with comment and font-lock.
+
鐃緒申;;
+
鐃緒申;; Copyright (C) 1997, 1999 Free Software Foundation, Inc.
+
鐃緒申;;
+
鐃緒申;; Author:  Peter Breton <[e-mail]>
+
鐃緒申;; Created: Fri Sep 27 1996
+
鐃緒申;; Keywords: generic, comment, font-lock
+
鐃緒申
+
鐃緒申;; 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.
+
鐃緒申
+
鐃緒申;; Purpose:
+
鐃緒申
+
鐃緒申;; Meta-mode to create simple major modes
+
鐃緒申;; with basic comment and font-lock support
+
鐃緒申
+
鐃緒申;;; Commentary:
+
鐃緒申
+
鐃緒申;; INTRODUCTION:
+
鐃緒申
+
鐃緒申;; Generic-mode is a meta-mode which can be used to define small modes
+
鐃緒申;; which provide basic comment and font-lock support.  These modes are
+
鐃緒申;; intended for the many configuration files and such which are too small
+
鐃緒申;; for a "real" mode, but still have a regular syntax, comment characters
+
鐃緒申;; and the like.
+
鐃緒申;;
+
鐃緒申;; Each generic mode can define the following:
+
鐃緒申;;
+
鐃緒申;; * List of comment-characters.  The entries in this list should be
+
鐃緒申;;   either a character, a one or two character string or a cons pair.
+
鐃緒申;;   If the entry is a character or a one-character string
+
鐃緒申;;   LIMITATIONS:  Emacs does not support comment strings of more than
+
鐃緒申;;   two characters in length.
+
鐃緒申;;
+
鐃緒申;; * List of keywords to font-lock.  Each keyword should be a string.
+
鐃緒申;;   If you have additional keywords which should be highlighted in a face
+
鐃緒申;;   different from `font-lock-keyword-face', you can use the convenience
+
鐃緒申;;   function `generic-make-keywords-list' (which see), and add the
+
鐃緒申;;   result to the following list:
+
鐃緒申;; 
+
鐃緒申;; * Additional expressions to font-lock.  This should be a list of
+
鐃緒申;;   expressions, each of which should be of the same form
+
鐃緒申;;   as those in `font-lock-defaults-alist'.
+
鐃緒申;;   
+
鐃緒申;; * List of regular expressions to be placed in auto-mode-alist.
+
鐃緒申;;
+
鐃緒申;; * List of functions to call to do some additional setup
+
鐃緒申;;
+
鐃緒申;; This should pretty much cover basic functionality; if you need much
+
鐃緒申;; more than this, or you find yourself writing extensive customizations,
+
鐃緒申;; perhaps you should be writing a major mode instead!
+
鐃緒申;;
+
鐃緒申;; LOCAL VARIABLES:
+
鐃緒申;;
+
鐃緒申;; To put a file into generic mode using local variables, use a line
+
鐃緒申;; like this in a Local Variables block:
+
鐃緒申;;
+
鐃緒申;;   mode: default-generic
+
鐃緒申;;
+
鐃緒申;; Do NOT use "mode: generic"!
+
鐃緒申;; See also "AUTOMATICALLY ENTERING GENERIC MODE" below.
+
鐃緒申;;   
+
鐃緒申;; DEFINING NEW GENERIC MODES:
+
鐃緒申;;
+
鐃緒申;; Use the `define-generic-mode' function to define new modes.
+
鐃緒申;; For example:
+
鐃緒申;;
+
鐃緒申;;   (require 'generic)
+
鐃緒申;;   (define-generic-mode 'foo-generic-mode
+
鐃緒申;;                        (list ?% )
+
鐃緒申;;                        (list "keyword")
+
鐃緒申;;                        nil
+
鐃緒申;;			  (list "\.FOO")
+
鐃緒申;;			  (list 'foo-setup-function))
+
鐃緒申;;
+
鐃緒申;; defines a new generic-mode `foo-generic-mode', which has '%' as a
+
鐃緒申;; comment character, and "keyword" as a keyword. When files which end in
+
鐃緒申;; '.FOO' are loaded, Emacs will go into foo-generic-mode and call
+
鐃緒申;; foo-setup-function.  You can also use the function `foo-generic-mode'
+
鐃緒申;; (which is interactive) to put a buffer into foo-generic-mode.
+
鐃緒申;;
+
鐃緒申;; AUTOMATICALLY ENTERING GENERIC MODE:
+
鐃緒申;;
+
鐃緒申;; Generic-mode provides a hook which automatically puts a
+
鐃緒申;; file into default-generic-mode if the first few lines of a file in
+
鐃緒申;; fundamental mode start with a hash comment character. To disable
+
鐃緒申;; this functionality, set the variable `generic-use-find-file-hook'
+
鐃緒申;; to nil BEFORE loading generic-mode. See the variables
+
鐃緒申;; `generic-lines-to-scan' and `generic-find-file-regexp' for customization
+
鐃緒申;; options.
+
鐃緒申;; 
+
鐃緒申;; GOTCHAS:
+
鐃緒申;;
+
鐃緒申;; Be careful that your font-lock definitions are correct.  Getting them
+
鐃緒申;; wrong can cause emacs to continually attempt to fontify! This problem
+
鐃緒申;; is not specific to generic-mode.
+
鐃緒申;; 
+
鐃緒申
+
鐃緒申;; Credit for suggestions, brainstorming, help with debugging:
+
鐃緒申;;   [e-mail] (Alfred Correira)
+
鐃緒申
+
鐃緒申;;; Code:
+
鐃緒申
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申;; Internal Variables
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申
+
鐃緒申(defvar generic-font-lock-defaults nil
+
鐃緒申  "Global defaults for font-lock in a generic mode.")
+
鐃緒申(make-variable-buffer-local 'generic-font-lock-defaults)
+
鐃緒申
+
鐃緒申(defvar generic-mode-name 'default-generic-mode
+
鐃緒申  "The name of the generic mode.
+
鐃緒申This is the car of one of the items in `generic-mode-alist'.
+
鐃緒申This variable is buffer-local.")
+
鐃緒申(make-variable-buffer-local 'generic-mode-name)
+
鐃緒申
+
鐃緒申(defvar generic-comment-list nil
+
鐃緒申  "List of comment characters for a generic mode.")
+
鐃緒申(make-variable-buffer-local 'generic-comment-list)
+
鐃緒申
+
鐃緒申(defvar generic-keywords-list nil
+
鐃緒申  "List of keywords for a generic mode.")
+
鐃緒申(make-variable-buffer-local 'generic-keywords-list)
+
鐃緒申
+
鐃緒申(defvar generic-font-lock-expressions nil
+
鐃緒申  "List of font-lock expressions for a generic mode.")
+
鐃緒申(make-variable-buffer-local 'generic-font-lock-expressions)
+
鐃緒申
+
鐃緒申(defvar generic-mode-function-list nil
+
鐃緒申  "List of customization functions to call for a generic mode.")
+
鐃緒申(make-variable-buffer-local 'generic-mode-function-list)
+
鐃緒申
+
鐃緒申(defvar generic-mode-syntax-table nil
+
鐃緒申  "Syntax table for use in a generic mode.")
+
鐃緒申(make-variable-buffer-local 'generic-mode-syntax-table)
+
鐃緒申
+
鐃緒申(defvar generic-mode-alist nil
+
鐃緒申  "An association list for `generic-mode'.
+
鐃緒申Each entry in the list looks like this:
+
鐃緒申
+
鐃緒申 NAME COMMENT-LIST KEYWORD-LIST FONT-LOCK-LIST AUTO-MODE-LIST FUNCTION-LIST.
+
鐃緒申
+
鐃緒申Do not add entries to this list directly; use `define-generic-mode'
+
鐃緒申instead (which see).")
+
鐃緒申
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申;; Customization Variables
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申
+
鐃緒申(defgroup generic nil
+
鐃緒申  "Define simple major modes with comment and font-lock support."
+
鐃緒申  :prefix "generic-"
+
鐃緒申  :group 'extensions)
+
鐃緒申
+
鐃緒申(defcustom generic-use-find-file-hook t
+
鐃緒申  "*If non-nil, add a hook to enter default-generic-mode automatically.
+
鐃緒申This is done if the first few lines of a file in fundamental mode start
+
鐃緒申with a hash comment character."
+
鐃緒申  :group 'generic
+
鐃緒申  :type  'boolean
+
鐃緒申  )
+
鐃緒申
+
鐃緒申(defcustom generic-lines-to-scan 3
+
鐃緒申  "*Number of lines that `generic-mode-find-file-hook' looks at.
+
鐃緒申Relevant when deciding whether to enter `generic-mode' automatically.
+
鐃緒申This variable should be set to a small positive number."
+
鐃緒申  :group 'generic
+
鐃緒申  :type  'integer
+
鐃緒申  )
+
鐃緒申
+
鐃緒申(defcustom generic-find-file-regexp "#.*\n\\(.*\n\\)?"
+
鐃緒申  "*Regular expression used by `generic-mode-find-file-hook'.
+
鐃緒申Used to determine if files in fundamental mode should be put into
+
鐃緒申`default-generic-mode' instead."
+
鐃緒申  :group 'generic
+
鐃緒申  :type  'regexp
+
鐃緒申  )
+
鐃緒申
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申;; Inline functions
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申
+
鐃緒申(defsubst generic-read-type ()
+
鐃緒申  (completing-read
+
鐃緒申   "Generic Type: "
+
鐃緒申   (mapcar
+
鐃緒申    '(lambda (elt) (list (symbol-name (car elt))))
+
鐃緒申    generic-mode-alist) nil t))
+
鐃緒申
+
鐃緒申;; Basic sanity checks. It does *not* check whether the elements of the lists
+
鐃緒申;; are of the correct type.
+
鐃緒申(defsubst generic-mode-sanity-check (name comment-list   keyword-list
+
鐃緒申					  font-lock-list auto-mode-list
+
鐃緒申					  function-list  &optional description)
+
鐃緒申  (and (not (symbolp name))
+
鐃緒申      (error "%s is not a symbol" (princ name)))
+
鐃緒申
+
鐃緒申  (mapcar '(lambda (elt)
+
鐃緒申	     (if (not (listp elt))
+
鐃緒申		 (error "%s is not a list" (princ elt))))
+
鐃緒申	  (list comment-list   keyword-list font-lock-list
+
鐃緒申		auto-mode-list function-list))
+
鐃緒申
+
鐃緒申  (and (not (or (null description) (stringp description)))
+
鐃緒申      (error "Description must be a string or nil"))
+
鐃緒申)
+
鐃緒申
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申;; Functions
+
鐃緒申;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
鐃緒申
+
鐃緒申;;;###autoload
+
鐃緒申(defun define-generic-mode (name comment-list    keyword-list   font-lock-list
+
鐃緒申				 auto-mode-list  function-list
+
鐃緒申				 &optional description)
+
鐃緒申  "Create a new generic mode with NAME.
+
鐃緒申
+
鐃緒申Args: (NAME COMMENT-LIST KEYWORD-LIST FONT-LOCK-LIST AUTO-MODE-LIST
+
鐃緒申            FUNCTION-LIST &optional DESCRIPTION)
+
鐃緒申
+
鐃緒申NAME should be a symbol; its string representation is used as the function
+
鐃緒申name. If DESCRIPTION is provided, it is used as the docstring for the new
+
鐃緒申function.
+
鐃緒申
+
鐃緒申COMMENT-LIST is a list, whose entries are either a single character,
+
鐃緒申a one or two character string or a cons pair. If the entry is a character
+
鐃緒申or a one-character string, it is added to the mode's syntax table with
+
鐃緒申comment-start syntax. If the entry is a cons pair, the elements of the
+
鐃緒申pair are considered to be comment-start and comment-end respectively.
+
鐃緒申Note that Emacs has limitations regarding comment characters.
+
鐃緒申
+
鐃緒申KEYWORD-LIST is a list of keywords to highlight with `font-lock-keyword-face'.
+
鐃緒申Each keyword should be a string.
+
鐃緒申
+
鐃緒申FONT-LOCK-LIST is a list of additional expressions to highlight. Each entry
+
鐃緒申in the list should have the same form as an entry in `font-lock-defaults-alist'
+
鐃緒申
+
鐃緒申AUTO-MODE-LIST is a list of regular expressions to add to auto-mode-alist.
+
鐃緒申These regexps are added to auto-mode-alist as soon as `define-generic-mode'
+
鐃緒申is called; any old regexps with the same name are removed.
+
鐃緒申
+
鐃緒申FUNCTION-LIST is a list of functions to call to do some additional setup.
+
鐃緒申
+
鐃緒申See the file generic-x.el for some examples of `define-generic-mode'."
+
鐃緒申
+
鐃緒申  ;; Basic sanity check
+
鐃緒申  (generic-mode-sanity-check name
+
鐃緒申			     comment-list    keyword-list   font-lock-list
+
鐃緒申			     auto-mode-list  function-list  description)
+
鐃緒申
+
鐃緒申  ;; Remove any old entry
+
鐃緒申  (setq generic-mode-alist
+
鐃緒申	(delq (assq name generic-mode-alist)
+
鐃緒申	      generic-mode-alist))
+
鐃緒申  
+
鐃緒申  ;; Add a new entry
+
鐃緒申  (setq generic-mode-alist
+
鐃緒申	(append
+
鐃緒申	 (list
+
鐃緒申	  (list
+
鐃緒申	   name comment-list keyword-list font-lock-list
+
鐃緒申	   auto-mode-list    function-list
+
鐃緒申	   ))
+
鐃緒申	 generic-mode-alist))
+
鐃緒申
+
鐃緒申  ;; Add it to auto-mode-alist
+
鐃緒申  (generic-add-to-auto-mode name auto-mode-list t)
+
鐃緒申  
+
鐃緒申  ;; Define a function for it
+
鐃緒申  (generic-create-generic-function name description)
+
鐃緒申  )
+
鐃緒申
+
鐃緒申(defun generic-add-to-auto-mode (mode auto-mode-list
+
鐃緒申				      &optional remove-old prepend)
+
鐃緒申  "Add the entries for MODE to `auto-mode-alist', supplied as AUTO-MODE-ALIST.
+
鐃緒申If remove-old is non-nil, removes old entries first. If prepend is
+
鐃緒申non-nil, prepends entries to auto-mode-alist; otherwise, appends them."
+
鐃緒申
+
鐃緒申  (if (not (listp auto-mode-list))
+
鐃緒申      (error "%s is not a list" (princ auto-mode-list)))
+
鐃緒申
+
鐃緒申  (let ((new-mode (intern (symbol-name mode))))
+
鐃緒申    (and remove-old
+
鐃緒申	 (let ((auto-mode-entry))
+
鐃緒申	   (while (setq auto-mode-entry (rassq new-mode auto-mode-alist))
+
鐃緒申	     (setq auto-mode-alist
+
鐃緒申		   (delq auto-mode-entry
+
鐃緒申			 auto-mode-alist)))))
+
鐃緒申
+
鐃緒申    (mapcar '(lambda (entry)
+
鐃緒申	       (generic-add-auto-mode-entry new-mode entry prepend))
+
鐃緒申	    auto-mode-list)))
+
鐃緒申
+
鐃緒申(defun generic-add-auto-mode-entry (name entry &optional prepend)
+
鐃緒申  "Add a new NAME regexp with ENTRY to the end of `auto-mode-alist'.
+
鐃緒申If prepend is non-nil, add the entry to the front of the list."
+
鐃緒申  (let ((new-entry (list (cons entry name))))
+
鐃緒申    (setq auto-mode-alist
+
鐃緒申	  (if prepend
+
鐃緒申	      (append new-entry auto-mode-alist)
+
鐃緒申	    (append auto-mode-alist new-entry)))))
+
鐃緒申   
+
鐃緒申(defun generic-create-generic-function (name &optional description)
+
鐃緒申  "Create a generic mode function with NAME.
+
鐃緒申If DESCRIPTION is provided, it is used as the docstring."
+
鐃緒申  (let ((symname (symbol-name name)))
+
鐃緒申    ;; Use `defalias', not `fset' to make the mode appear on
+
鐃緒申    ;; load-history.
+
鐃緒申    (defalias (intern symname)
+
鐃緒申      (list 'lambda nil
+
鐃緒申	    (or description
+
鐃緒申		(concat "Generic mode for type " symname))
+
鐃緒申	    (list 'interactive)
+
鐃緒申	    (list 'generic-mode-with-type (list 'quote name))))))
+
鐃緒申
+
鐃緒申(defun generic-mode-with-type (&optional mode)
+
鐃緒申  "Go into the generic-mode MODE."
+
鐃緒申  (let* ((type (or mode generic-mode-name))
+
鐃緒申	 (generic-mode-list  (assoc type generic-mode-alist))
+
鐃緒申	 (generic-mode-hooks (intern (concat (symbol-name type) "-hooks")))
+
鐃緒申	 )
+
鐃緒申
+
鐃緒申    (and (not generic-mode-list)
+
鐃緒申	 (error "Can't find generic-mode information for type %s"
+
鐃緒申		(princ generic-mode-name)))
+
鐃緒申
+
鐃緒申    ;; Put this after the point where we read generic-mode-name!
+
鐃緒申    (kill-all-local-variables)
+
鐃緒申
+
鐃緒申    (setq
+
鐃緒申     generic-mode-name             type
+
鐃緒申     generic-comment-list          (nth 1 generic-mode-list)
+
鐃緒申     generic-keywords-list	   (nth 2 generic-mode-list)
+
鐃緒申     generic-font-lock-expressions (nth 3 generic-mode-list)
+
鐃緒申     generic-mode-function-list	   (nth 5 generic-mode-list)
+
鐃緒申     major-mode			   type
+
鐃緒申     mode-name			   (symbol-name type)
+
鐃緒申     )
+
鐃緒申
+
鐃緒申    (generic-mode-set-comments     generic-comment-list)
+
鐃緒申
+
鐃緒申    ;; Font-lock functionality
+
鐃緒申    ;; Font-lock-defaults are always set even if there are no keywords
+
鐃緒申    ;; or font-lock expressions, so comments can be highlighted.
+
鐃緒申    (setq generic-font-lock-defaults nil)
+
鐃緒申    (generic-mode-set-font-lock      generic-keywords-list
+
鐃緒申				     generic-font-lock-expressions)
+
鐃緒申    (make-local-variable	    'font-lock-defaults)
+
鐃緒申    (setq font-lock-defaults (list 'generic-font-lock-defaults nil))
+
鐃緒申
+
鐃緒申    ;; Call a list of functions
+
鐃緒申    (and generic-mode-function-list
+
鐃緒申	 (mapcar 'funcall generic-mode-function-list))
+
鐃緒申
+
鐃緒申    (run-hooks generic-mode-hooks)
+
鐃緒申    )
+
鐃緒申  )
+
鐃緒申
+
鐃緒申;;;###autoload
+
鐃緒申(defun generic-mode (type)
+
鐃緒申  "Basic comment and font-lock functionality for `generic' files.
+
鐃緒申(Files which are too small to warrant their own mode, but have
+
鐃緒申comment characters, keywords, and the like.)
+
鐃緒申
+
鐃緒申To define a generic-mode, use the function `define-generic-mode'.
+
鐃緒申Some generic modes are defined in `generic-x.el'."
+
鐃緒申  (interactive
+
鐃緒申   (list (generic-read-type)))
+
鐃緒申  (generic-mode-with-type (intern type)))
+
鐃緒申
+
鐃緒申;;; Comment Functionality
+
鐃緒申(defun generic-mode-set-comments (comment-list)
+
鐃緒申  "Set up comment functionality for generic mode."
+
鐃緒申  (if (null comment-list)
+
鐃緒申      nil
+
鐃緒申    (let ((generic-mode-syntax-table (make-syntax-table)))
+
鐃緒申      (make-local-variable	     'comment-start)
+
鐃緒申      (make-local-variable	     'comment-start-skip)
+
鐃緒申      (make-local-variable	     'comment-end)
+
鐃緒申      (mapcar 'generic-mode-set-a-comment comment-list)
+
鐃緒申      (set-syntax-table    generic-mode-syntax-table))))
+
鐃緒申
+
鐃緒申(defun generic-mode-set-a-comment (comment)
+
鐃緒申  (and (char-or-string-p comment)
+
鐃緒申       (if (stringp comment)
+
鐃緒申	   (cond
+
鐃緒申	    ((eq (length comment) 1)
+
鐃緒申	     (generic-mode-set-comment-char
+
鐃緒申	      (string-to-char comment)))
+
鐃緒申	    ((eq (length comment) 2)
+
鐃緒申	     (generic-mode-set-comment-string comment))
+
鐃緒申	    (t
+
鐃緒申	     (error "Character string %s must be one or two characters long"
+
鐃緒申		    comment))
+
鐃緒申	    )
+
鐃緒申	 (generic-mode-set-comment-char comment)))
+
鐃緒申  (and (consp comment)
+
鐃緒申       (generic-mode-set-comment-pair comment)))
+
鐃緒申
+
鐃緒申(defun generic-mode-set-comment-char (comment-char)
+
鐃緒申  "Set COMMENT-CHAR as a comment character for generic mode."
+
鐃緒申  (if (not comment-char)
+
鐃緒申      nil
+
鐃緒申    (setq
+
鐃緒申     comment-end         ""
+
鐃緒申     comment-start       (char-to-string comment-char)
+
鐃緒申     comment-start-skip  (concat comment-start "+ *")
+
鐃緒申     )
+
鐃緒申      
+
鐃緒申    (modify-syntax-entry comment-char "<"
+
鐃緒申			 generic-mode-syntax-table)
+
鐃緒申    (modify-syntax-entry ?\n ">"
+
鐃緒申			 generic-mode-syntax-table)))
+
鐃緒申
+
鐃緒申(defun generic-mode-set-comment-string (comment-string)
+
鐃緒申  "Set COMMENT-STRING as a comment string for generic mode."
+
鐃緒申  (if (not comment-string)
+
鐃緒申      nil
+
鐃緒申    (setq
+
鐃緒申     comment-end         ""
+
鐃緒申     comment-start       comment-string
+
鐃緒申     comment-start-skip  (concat comment-start " *")
+
鐃緒申     )
+
鐃緒申      
+
鐃緒申    (let ((first  (elt comment-string 0))
+
鐃緒申	  (second (elt comment-string 1)))
+
鐃緒申      ;; C++ style comments
+
鐃緒申      (if (char-equal first second)
+
鐃緒申	  (progn
+
鐃緒申	    (modify-syntax-entry first "<12b"
+
鐃緒申				 generic-mode-syntax-table)
+
鐃緒申	    (modify-syntax-entry ?\n ">b"
+
鐃緒申				 generic-mode-syntax-table)))
+
鐃緒申      ;; Some other two character string
+
鐃緒申      (modify-syntax-entry first  "<1"
+
鐃緒申			   generic-mode-syntax-table)
+
鐃緒申      (modify-syntax-entry second "<2"
+
鐃緒申			   generic-mode-syntax-table)
+
鐃緒申      (modify-syntax-entry ?\n ">"
+
鐃緒申			   generic-mode-syntax-table))))
+
鐃緒申
+
鐃緒申(defun generic-mode-set-comment-pair (comment-pair)
+
鐃緒申  "Set COMMENT-PAIR as a comment start and end for generic mode."
+
鐃緒申  (let ((generic-comment-start (car comment-pair))
+
鐃緒申	(generic-comment-end   (cdr comment-pair))
+
鐃緒申	)
+
鐃緒申    (setq
+
鐃緒申     comment-end         generic-comment-end
+
鐃緒申     comment-start       generic-comment-start
+
鐃緒申     comment-start-skip  (concat generic-comment-start " *")
+
鐃緒申     )
+
鐃緒申
+
鐃緒申    ;; Sanity checks
+
鐃緒申    (and (not (and (stringp generic-comment-start)
+
鐃緒申		   (stringp generic-comment-end)))
+
鐃緒申	 (error "Elements of cons pair must be strings"))
+
鐃緒申    (and (not (and (equal (length generic-comment-start) 2)
+
鐃緒申		   (equal (length generic-comment-end) 2)))
+
鐃緒申	(error "Start and end must be exactly two characters long"))
+
鐃緒申
+
鐃緒申    (let ((first   (elt generic-comment-start 0))
+
鐃緒申	  (second  (elt generic-comment-start 1))
+
鐃緒申	  (third   (elt generic-comment-end   0))
+
鐃緒申	  (fourth  (elt generic-comment-end   1))
+
鐃緒申	  )
+
鐃緒申
+
鐃緒申      (modify-syntax-entry first   ". 1" generic-mode-syntax-table)
+
鐃緒申      (modify-syntax-entry second  ". 2" generic-mode-syntax-table)
+
鐃緒申
+
鐃緒申      (modify-syntax-entry
+
鐃緒申       third
+
鐃緒申       (concat
+
鐃緒申	"."
+
鐃緒申	(cond
+
鐃緒申	 ((char-equal first   third) " 13")
+
鐃緒申	 ((char-equal second  third) " 23")
+
鐃緒申	 (t			     " 3"))
+
鐃緒申	)
+
鐃緒申       generic-mode-syntax-table)
+
鐃緒申
+
鐃緒申      (modify-syntax-entry
+
鐃緒申       fourth
+
鐃緒申       (concat
+
鐃緒申	"."
+
鐃緒申	(cond
+
鐃緒申	 ((char-equal first   fourth) " 14")
+
鐃緒申	 ((char-equal second  fourth) " 24")
+
鐃緒申	 (t			      " 4"))
+
鐃緒申	)
+
鐃緒申       generic-mode-syntax-table)
+
鐃緒申      )))
+
鐃緒申
+
鐃緒申(defun generic-mode-set-font-lock (keywords font-lock-expressions)
+
鐃緒申  "Set up font-lock functionality for generic mode."
+
鐃緒申  (let ((generic-font-lock-expressions))
+
鐃緒申    ;; Keywords
+
鐃緒申    (and keywords
+
鐃緒申	(setq
+
鐃緒申	 generic-font-lock-expressions
+
鐃緒申	 (append
+
鐃緒申	  (list (let ((regexp (regexp-opt keywords)))
+
鐃緒申		  (list (concat "\\<\\(" regexp "\\)\\>")
+
鐃緒申			1
+
鐃緒申			'font-lock-keyword-face)))
+
鐃緒申	  generic-font-lock-expressions)))
+
鐃緒申    ;; Other font-lock expressions
+
鐃緒申    (and font-lock-expressions
+
鐃緒申	(setq generic-font-lock-expressions
+
鐃緒申	      (append
+
鐃緒申	       font-lock-expressions
+
鐃緒申	       generic-font-lock-expressions)))
+
鐃緒申    (and (or font-lock-expressions keywords)
+
鐃緒申	 (setq generic-font-lock-defaults generic-font-lock-expressions))
+
鐃緒申    ))
+
鐃緒申
+
鐃緒申;; Support for [KEYWORD] constructs found in INF, INI and Samba files
+
鐃緒申(defun generic-bracket-support ()
+
鐃緒申  (setq imenu-generic-expression
+
鐃緒申	'((nil "^\\[\\(.*\\)\\]" 1))
+
鐃緒申        imenu-case-fold-search t))
+
鐃緒申
+
鐃緒申;; This generic mode is always defined
+
鐃緒申(define-generic-mode 'default-generic-mode (list ?#)  nil nil nil nil)
+
鐃緒申
+
鐃緒申;; A more general solution would allow us to enter generic-mode for
+
鐃緒申;; *any* comment character, but would require us to synthesize a new
+
鐃緒申;; generic-mode on the fly. I think this gives us most of what we
+
鐃緒申;; want.
+
鐃緒申(defun generic-mode-find-file-hook ()
+
鐃緒申  "Hook function to enter default-generic-mode automatically.
+
鐃緒申Done if the first few lines of a file in `fundamental-mode' start with
+
鐃緒申a hash comment character.  This hook will be installed if the variable
+
鐃緒申`generic-use-find-file-hook' is non-nil.  The variable
+
鐃緒申`generic-lines-to-scan' determines the number of lines to look at."
+
鐃緒申  (if (not (eq major-mode 'fundamental-mode))
+
鐃緒申      nil
+
鐃緒申    (and (or (> 1  generic-lines-to-scan)
+
鐃緒申	     (< 50 generic-lines-to-scan))
+
鐃緒申	 (error "Variable `generic-lines-to-scan' should be set to a small"
+
鐃緒申		" positive number"))
+
鐃緒申    (let ((comment-regexp "")
+
鐃緒申	  (count 0)
+
鐃緒申	  )
+
鐃緒申      (while (< count generic-lines-to-scan)
+
鐃緒申	(setq comment-regexp (concat comment-regexp
+
鐃緒申				     generic-find-file-regexp))
+
鐃緒申	(setq count (1+ count)))
+
鐃緒申      (save-excursion
+
鐃緒申	(goto-char (point-min))
+
鐃緒申	(and (looking-at comment-regexp)
+
鐃緒申	     (generic-mode-with-type 'default-generic-mode))))))
+
鐃緒申
+
鐃緒申(defun generic-mode-ini-file-find-file-hook ()
+
鐃緒申  "Hook function to enter default-generic-mode automatically for INI files.
+
鐃緒申Done if the first few lines of a file in `fundamental-mode' look like an
+
鐃緒申INI file.  This hook is NOT installed by default."
+
鐃緒申  (and (eq major-mode 'fundamental-mode)
+
鐃緒申       (save-excursion
+
鐃緒申	 (goto-char (point-min))
+
鐃緒申	 (and (looking-at "^\\s-*\\[.*\\]")
+
鐃緒申	      (generic-mode-with-type 'ini-generic-mode)))))
+
鐃緒申
+
鐃緒申(and generic-use-find-file-hook
+
鐃緒申    (add-hook 'find-file-hooks 'generic-mode-find-file-hook))
+
鐃緒申
+
鐃緒申(defun generic-make-keywords-list (keywords-list face &optional prefix suffix)
+
鐃緒申  "Return a regular expression matching the specified KEYWORDS-LIST.
+
鐃緒申The regexp is highlighted with FACE."
+
鐃緒申  (and (not (listp keywords-list))
+
鐃緒申       (error "Keywords argument must be a list of strings"))
+
鐃緒申  (list (concat (or prefix "")
+
鐃緒申		"\\<\\("
+
鐃緒申		;; Use an optimized regexp.
+
鐃緒申		(regexp-opt keywords-list t)
+
鐃緒申		"\\)\\>"
+
鐃緒申		(or suffix ""))
+
鐃緒申	1
+
鐃緒申	face))
+
鐃緒申
+
鐃緒申(provide 'generic)
+
鐃緒申
+
鐃緒申;;; generic.el ends here