From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Masatake YAMATO Newsgroups: gmane.emacs.devel Subject: Re: |PATCH| describe-minor-mode and describe-minor-mode-from-indicator Date: Sun, 30 Mar 2003 16:51:24 +0900 (JST) Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <20030330.165124.126582929.jet@gyve.org> References: <20030131.010427.55502131.jet@gyve.org> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: Text/Plain; charset=us-ascii Content-Transfer-Encoding: 7bit X-Trace: main.gmane.org 1049012618 30248 80.91.224.249 (30 Mar 2003 08:23:38 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Sun, 30 Mar 2003 08:23:38 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Sun Mar 30 10:23:37 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 18zY6L-0007rk-00 for ; Sun, 30 Mar 2003 10:23:37 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.12 #1 (Debian)) id 18zY9a-0004fg-00 for ; Sun, 30 Mar 2003 10:26:58 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.10.13) id 18zY6O-0001yl-00 for emacs-devel@quimby.gnus.org; Sun, 30 Mar 2003 03:23:40 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.10.13) id 18zY64-0001ww-00 for emacs-devel@gnu.org; Sun, 30 Mar 2003 03:23:20 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.10.13) id 18zY62-0001sy-00 for emacs-devel@gnu.org; Sun, 30 Mar 2003 03:23:19 -0500 Original-Received: from r-maa.spacetown.ne.jp ([210.130.136.40]) by monty-python.gnu.org with esmtp (Exim 4.10.13) id 18zY62-0001N3-00; Sun, 30 Mar 2003 03:23:18 -0500 Original-Received: from localhost (h219-110-074-222.catv01.itscom.jp [219.110.74.222]) by r-maa.spacetown.ne.jp (8.11.6) with ESMTP id h2U8N8C28799; Sun, 30 Mar 2003 17:23:08 +0900 (JST) Original-To: rms@gnu.org In-Reply-To: X-Mailer: Mew version 3.1.52 on Emacs 21.2 / Mule 5.0 (SAKAKI) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1b5 Precedence: list List-Id: Emacs development discussions. List-Help: List-Post: List-Subscribe: , List-Archive: List-Unsubscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:12747 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:12747 (Two months ago, my patch is reviewd by RMS and I got comments about help for minor modes. I could not find time to improve. Now I do.) This patch provides functions that: 1. you can get help for current selected major mode and minor modes with clicking major and minor modes string on the mode line. 2. M-x describe-minor-mode, help for a specified minor mode like M-x describe-mode. Review results(summary): I used popup menu to invoke describe-mode and describe-minor-mode. RMS gave me a comment that I should use mouse-2 and help-echo instead of popup menu. Here I did. Masatake YAMATO 2003-03-30 Masatake YAMATO * bindings.el (mode-line-major-mode-keymap): New variable. (mode-line-minor-mode-help): New function. bound to mode-line-minor-mode-keymap. (mode-line-modes): split mode-line-mode definitions to mode-name, mode-line-process and minor-mode-alist. For mode-name, mode-line-major-mode-keymap is used. * help.el (describe-minor-mode): (describe-minor-mode-from-indicator): (lookup-minor-mode-from-indicator): New functions. Index: help.el =================================================================== RCS file: /cvsroot/emacs/emacs/lisp/help.el,v retrieving revision 1.257 diff -u -r1.257 help.el --- help.el 12 Feb 2003 23:13:43 -0000 1.257 +++ help.el 30 Mar 2003 08:13:16 -0000 @@ -611,6 +611,74 @@ (setq minor-modes (cdr minor-modes)))) (print-help-return-message)))) +(defun describe-minor-mode (minor-mode) + "Display documentation of a minor mode given as MINOR-MODE." + (interactive (list (intern (completing-read + "Minor mode: " + (delete nil (mapcar + (function (lambda (x) + (if (eval (car x)) + (symbol-name (car x))))) + minor-mode-alist)))))) + (if (fboundp minor-mode) + (describe-function minor-mode) + (describe-variable minor-mode))) + +(defun describe-minor-mode-from-indicator (indicator) + "Display documentation of a minor mode specified by INDICATOR." + (interactive (list + (completing-read + "Minor mode indicator: " + (delete nil + (mapcar + #'(lambda (x) + (if (eval (car x)) + (let ((i (expand-minor-mode-indicator-object (cadr x)))) + (if (and (< 0 (length i)) + (string= " " (substring i 0 1))) + (substring i 1) + i)))) + minor-mode-alist))))) + (let ((minor-mode (lookup-minor-mode-from-indicator indicator))) + (if minor-mode + (describe-minor-mode minor-mode) + (error "Cannot find minor mode for `%s'" indicator)))) + +(defun lookup-minor-mode-from-indicator (indicator) + "Return a minor mode symbol from its indicator on the modeline." + (if (and (< 0 (length indicator)) + (not (string= " " (substring indicator 0 1)))) + (setq indicator (concat " " indicator))) + (let ((minor-modes minor-mode-alist) + result) + (while minor-modes + (let* ((minor-mode (car (car minor-modes))) + (anindicator (car (cdr (car minor-modes))))) + (setq anindicator (expand-minor-mode-indicator-object anindicator)) + (if (and (stringp anindicator) + (string= anindicator indicator)) + (setq result minor-mode + minor-modes nil) + (setq minor-modes (cdr minor-modes))))) + result)) + +(defun expand-minor-mode-indicator-object (obj) + "Expand OBJ that represents a minor-mode indicator. +cdr part of a `minor-mode-alist' element(indicator object) is the +indicator of minor mode that is in car part. Normally indicator +object is a string. However, in some case it is more compound object +like cons cell. This function tries to make the compound object a string." + ;; copied from describe-mode + (while (and obj (symbolp obj) + (boundp obj) + (not (eq obj (symbol-value obj)))) + (setq obj (symbol-value obj))) + (when (and (consp obj) + (keywordp (car obj)) + (eq :eval (car obj))) + (setq obj (eval (cadr obj)))) + obj) + ;;; Automatic resizing of temporary buffers. Index: bindings.el =================================================================== RCS file: /cvsroot/emacs/emacs/lisp/bindings.el,v retrieving revision 1.112 diff -u -r1.112 bindings.el --- bindings.el 21 Dec 2002 20:19:37 -0000 1.112 +++ bindings.el 30 Mar 2003 08:13:16 -0000 @@ -256,11 +256,19 @@ (defvar mode-line-modes nil "Mode-line control for displaying major and minor modes.") +(defvar mode-line-major-mode-keymap nil "\ +Keymap to display on major mode.") + (defvar mode-line-minor-mode-keymap nil "\ -Keymap to display on major and minor modes.") +Keymap to display on minor modes.") + +(let ((map (make-sparse-keymap))) + (define-key map [mode-line mouse-2] 'describe-mode) + (setq mode-line-major-mode-keymap map)) ;; Menu of minor modes. (let ((map (make-sparse-keymap))) + (define-key map [mode-line mouse-2] 'mode-line-minor-mode-help) (define-key map [mode-line down-mouse-3] 'mode-line-mode-menu-1) (define-key map [header-line down-mouse-3] 'mode-line-mode-menu-1) (setq mode-line-minor-mode-keymap map)) @@ -292,8 +300,12 @@ (setq-default mode-line-modes (list (propertize "%[(" 'help-echo help-echo) - `(:propertize ("" mode-name mode-line-process minor-mode-alist) - help-echo "mouse-3: minor mode menu" + `(:propertize ("" mode-name) + help-echo "mouse-2: help for current major mode" + local-map ,mode-line-major-mode-keymap) + `(:propertize ("" mode-line-process)) + `(:propertize ("" minor-mode-alist) + help-echo "mouse-2: help for minor modes, mouse-3: minor mode menu" local-map ,mode-line-minor-mode-keymap) (propertize "%n" 'help-echo "mouse-2: widen" 'local-map (make-mode-line-mouse-map @@ -416,6 +428,12 @@ (defun mode-line-mode-menu (event) (interactive "@e") (x-popup-menu event mode-line-mode-menu)) + +(defun mode-line-minor-mode-help (event) + "Describe minor mode for EVENT occured on minor modes area of the mode line." + (interactive "@e") + (let ((indicator (car (nth 4 (car (cdr event)))))) + (describe-minor-mode-from-indicator indicator))) ;; Add menu of buffer operations to the buffer identification part ;; of the mode line.or header line.