view lisp/which-func.el @ 34661:ef8413670ea4

*** empty log message ***

+
鐃緒申;;; which-func.el --- Print current function in mode line
+
鐃緒申
+
鐃緒申;; Copyright (C) 1994, 1997, 1998 Free Software Foundation, Inc.
+
鐃緒申
+
鐃緒申;; Author:   Alex Rezinsky <[e-mail]>
+
鐃緒申;;           (doesn't seem to be responsive any more)
+
鐃緒申;; Keywords: mode-line, imenu, tools
+
鐃緒申
+
鐃緒申;; 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:
+
鐃緒申
+
鐃緒申;; This package prints name of function where your current point is
+
鐃緒申;; located in mode line. It assumes that you work with imenu package
+
鐃緒申;; and imenu--index-alist is up to date.
+
鐃緒申
+
鐃緒申;; KNOWN BUGS
+
鐃緒申;; ----------
+
鐃緒申;; Really this package shows not "function where the current point is
+
鐃緒申;; located now", but "nearest function which defined above the current
+
鐃緒申;; point". So if your current point is located after end of function
+
鐃緒申;; FOO but before begin of function BAR, FOO will be displayed in mode
+
鐃緒申;; line.
+
鐃緒申
+
鐃緒申;; TODO LIST
+
鐃緒申;; ---------
+
鐃緒申;;     1. Dependence on imenu package should be removed.  Separate
+
鐃緒申;; function determination mechanism should be used to determine the end
+
鐃緒申;; of a function as well as the beginning of a function.
+
鐃緒申;;     2. This package should be realized with the help of overlay
+
鐃緒申;; properties instead of imenu--index-alist variable.
+
鐃緒申
+
鐃緒申;;; History:
+
鐃緒申
+
鐃緒申;; THANKS TO
+
鐃緒申;; ---------
+
鐃緒申;; Per Abrahamsen   <[e-mail]>
+
鐃緒申;;     Some ideas (inserting  in mode-line,  using of post-command  hook
+
鐃緒申;;     and toggling this  mode) have  been   borrowed from  his  package
+
鐃緒申;;     column.el
+
鐃緒申;; Peter Eisenhauer <[e-mail]>
+
鐃緒申;;     Bug fixing in case nested indexes.
+
鐃緒申;; Terry Tateyama   <[e-mail]>
+
鐃緒申;;     Suggestion to use find-file-hooks for first imenu
+
鐃緒申;;     index building.
+
鐃緒申
+
鐃緒申;;; Code:
+
鐃緒申
+
鐃緒申;; Variables for customization
+
鐃緒申;; ---------------------------
+
鐃緒申;;  
+
鐃緒申(defvar which-func-unknown "???"
+
鐃緒申  "String to display in the mode line when current function is unknown.")
+
鐃緒申
+
鐃緒申(defgroup which-func nil
+
鐃緒申  "Mode to display the current function name in the modeline."
+
鐃緒申  :group 'tools
+
鐃緒申  :version "20.3")
+
鐃緒申
+
鐃緒申(defcustom which-func-modes
+
鐃緒申  '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode
+
鐃緒申		    fortran-mode)
+
鐃緒申  "List of major modes for which Which Function mode should be used.
+
鐃緒申For other modes it is disabled.  If this is equal to t,
+
鐃緒申then Which Function mode is enabled in any major mode that supports it."
+
鐃緒申  :group 'which-func
+
鐃緒申  :type '(choice (const :tag "All modes" t)
+
鐃緒申		 (repeat (symbol :tag "Major mode"))))
+
鐃緒申
+
鐃緒申(defcustom which-func-non-auto-modes nil
+
鐃緒申  "List of major modes where Which Function mode is inactive till Imenu is used.
+
鐃緒申This means that Which Function mode won't really do anything
+
鐃緒申until you use Imenu, in these modes.  Note that files
+
鐃緒申larger than `which-func-maxout' behave in this way too;
+
鐃緒申Which Function mode doesn't do anything until you use Imenu."
+
鐃緒申  :group 'which-func
+
鐃緒申  :type '(repeat (symbol :tag "Major mode")))
+
鐃緒申
+
鐃緒申(defcustom which-func-maxout 100000
+
鐃緒申  "Don't automatically compute the Imenu menu if buffer is this big or bigger.
+
鐃緒申Zero means compute the Imenu menu regardless of size."
+
鐃緒申  :group 'which-func
+
鐃緒申  :type 'integer)
+
鐃緒申
+
鐃緒申(defcustom which-func-format '("[" which-func-current "]")
+
鐃緒申  "Format for displaying the function in the mode line."
+
鐃緒申  :group 'which-func
+
鐃緒申  :type 'sexp)
+
鐃緒申
+
鐃緒申;;;###autoload
+
鐃緒申(defcustom which-func-mode-global nil
+
鐃緒申  "*Toggle `which-func-mode' globally.
+
鐃緒申Setting this variable directly does not take effect;
+
鐃緒申use either \\[customize] or the function `which-func-mode'."
+
鐃緒申  :set #'(lambda (symbol value)
+
鐃緒申	   (which-func-mode (if value 1 0)))
+
鐃緒申  :initialize 'custom-initialize-default
+
鐃緒申  :type    'boolean
+
鐃緒申  :group   'which-func
+
鐃緒申  :require 'which-func)
+
鐃緒申
+
鐃緒申(defvar which-func-cleanup-function nil
+
鐃緒申  "Function to transform a string before displaying it in the mode line.
+
鐃緒申The function is called with one argument, the string to display.
+
鐃緒申Its return value is displayed in the modeline.
+
鐃緒申If nil, no function is called.  The default value is nil.
+
鐃緒申
+
鐃緒申This feature can be useful if Imenu is set up to make more
+
鐃緒申detailed entries (e.g., containing the argument list of a function),
+
鐃緒申and you want to simplify them for the mode line
+
鐃緒申\(e.g., removing the parameter list to just have the function name.)")
+
鐃緒申
+
鐃緒申;;; Code, nothing to customize below here
+
鐃緒申;;; -------------------------------------
+
鐃緒申;;;
+
鐃緒申(require 'imenu)
+
鐃緒申
+
鐃緒申(defvar which-func-current  which-func-unknown)
+
鐃緒申(defvar which-func-previous which-func-unknown)
+
鐃緒申(make-variable-buffer-local 'which-func-current)
+
鐃緒申(make-variable-buffer-local 'which-func-previous)
+
鐃緒申
+
鐃緒申(defvar which-func-mode nil
+
鐃緒申  "Non-nil means display current function name in mode line.
+
鐃緒申This makes a difference only if `which-func-mode-global' is non-nil")
+
鐃緒申(make-variable-buffer-local 'which-func-mode)
+
鐃緒申;;(put 'which-func-mode 'permanent-local t)
+
鐃緒申
+
鐃緒申(add-hook 'find-file-hooks 'which-func-ff-hook t)
+
鐃緒申
+
鐃緒申(defun which-func-ff-hook ()
+
鐃緒申  "File find hook for Which Function mode.
+
鐃緒申It creates the Imenu index for the buffer, if necessary."
+
鐃緒申  (setq which-func-mode
+
鐃緒申	(and which-func-mode-global
+
鐃緒申	     (or (eq which-func-modes t) (member major-mode which-func-modes))))
+
鐃緒申
+
鐃緒申  (condition-case nil
+
鐃緒申      (if (and which-func-mode
+
鐃緒申	       (not (member major-mode which-func-non-auto-modes))
+
鐃緒申	       (or (null which-func-maxout)
+
鐃緒申		   (< buffer-saved-size which-func-maxout)
+
鐃緒申		   (= which-func-maxout 0)))
+
鐃緒申	  (setq imenu--index-alist
+
鐃緒申		(save-excursion (funcall imenu-create-index-function))))
+
鐃緒申    (error
+
鐃緒申     (setq which-func-mode nil))))
+
鐃緒申
+
鐃緒申(defun which-func-update ()
+
鐃緒申  ;; Update the string containing the current function.
+
鐃緒申  (when which-func-mode
+
鐃緒申    (condition-case info
+
鐃緒申	(progn
+
鐃緒申	  (setq which-func-current (or (which-function) which-func-unknown))
+
鐃緒申	  (unless (string= which-func-current which-func-previous)
+
鐃緒申	    (force-mode-line-update)
+
鐃緒申	    (setq which-func-previous which-func-current)))
+
鐃緒申      (error
+
鐃緒申       (which-func-mode -1)
+
鐃緒申       (error "Error in which-func-update: %s" info)))))
+
鐃緒申
+
鐃緒申;; This is the name people would normally expect.
+
鐃緒申;;;###autoload
+
鐃緒申(defalias 'which-function-mode 'which-func-mode)
+
鐃緒申
+
鐃緒申;;;###autoload
+
鐃緒申(defun which-func-mode (&optional arg)
+
鐃緒申  "Toggle Which Function mode, globally.
+
鐃緒申When Which Function mode is enabled, the current function name is
+
鐃緒申continuously displayed in the mode line, in certain major modes.
+
鐃緒申
+
鐃緒申With prefix ARG, turn Which Function mode on iff arg is positive,
+
鐃緒申and off otherwise."
+
鐃緒申  (interactive "P")
+
鐃緒申  (setq which-func-mode-global
+
鐃緒申	(or (and (null arg) which-func-mode-global)
+
鐃緒申	    (<= (prefix-numeric-value arg) 0)))
+
鐃緒申  (if which-func-mode-global
+
鐃緒申      ;; Turn it off
+
鐃緒申      (progn
+
鐃緒申	(remove-hook 'post-command-idle-hook 'which-func-update)
+
鐃緒申	(dolist (buf (buffer-list))
+
鐃緒申	  (with-current-buffer buf (setq which-func-mode nil))))
+
鐃緒申    ;;Turn it on
+
鐃緒申    (add-hook 'post-command-idle-hook 'which-func-update)
+
鐃緒申    (dolist (buf (buffer-list))
+
鐃緒申      (with-current-buffer buf
+
鐃緒申	(setq which-func-mode
+
鐃緒申	      (or (eq which-func-modes t)
+
鐃緒申		  (member major-mode which-func-modes)))))))
+
鐃緒申
+
鐃緒申(defun which-function ()
+
鐃緒申  "Return current function name based on point.
+
鐃緒申If `imenu--index-alist' does not exist, or is empty  or if point
+
鐃緒申is located before first function, returns nil."
+
鐃緒申  (let (name)
+
鐃緒申    ;; First try using imenu support.
+
鐃緒申    (when (and (boundp 'imenu--index-alist) imenu--index-alist)
+
鐃緒申      (let ((pair (car-safe imenu--index-alist))
+
鐃緒申	    (rest (cdr-safe imenu--index-alist)))
+
鐃緒申	(while (and (or rest pair)
+
鐃緒申		    (or (not (number-or-marker-p (cdr pair)))
+
鐃緒申			(> (point) (cdr pair))))
+
鐃緒申	  (setq name (car pair))
+
鐃緒申	  (setq pair (car-safe rest))
+
鐃緒申	  (setq rest (cdr-safe rest)))))
+
鐃緒申    ;; Try using add-log support.
+
鐃緒申    (when (and (null name) (boundp 'add-log-current-defun-function)
+
鐃緒申	       add-log-current-defun-function)
+
鐃緒申      (setq name (funcall add-log-current-defun-function)))
+
鐃緒申    ;; Filter the name if requested.
+
鐃緒申    (when name
+
鐃緒申      (if which-func-cleanup-function
+
鐃緒申	  (funcall which-func-cleanup-function name)
+
鐃緒申	name))))
+
鐃緒申
+
鐃緒申(provide 'which-func)
+
鐃緒申
+
鐃緒申;; which-func.el ends here