Mercurial > emacs
view lisp/emacs-lisp/helper.el @ 105870:26baacb565b0
* textmodes/tex-mode.el (tex-alt-dvi-print-command)
(tex-dvi-print-command, tex-bibtex-command, tex-start-commands)
(tex-start-options, slitex-run-command, latex-run-command)
(tex-run-command, tex-directory):
* textmodes/ispell.el (ispell-html-skip-alists)
(ispell-tex-skip-alists, ispell-tex-skip-alists):
* textmodes/fill.el (adaptive-fill-first-line-regexp):
(adaptive-fill-regexp):
* textmodes/dns-mode.el (auto-mode-alist):
* progmodes/python.el (interpreter-mode-alist):
* progmodes/etags.el (tags-compression-info-list):
* progmodes/etags.el (tags-file-name):
* net/browse-url.el (browse-url-galeon-program)
(browse-url-firefox-program):
* mail/sendmail.el (mail-signature-file)
(mail-citation-prefix-regexp):
* international/mule-conf.el (eight-bit):
* international/latexenc.el (latex-inputenc-coding-alist):
* international/fontset.el (x-pixel-size-width-font-regexp):
* emacs-lisp/warnings.el (warning-type-format):
* emacs-lisp/trace.el (trace-buffer):
* emacs-lisp/lisp-mode.el (lisp-interaction-mode-map)
(emacs-lisp-mode-map):
* calendar/holidays.el (holiday-solar-holidays)
(holiday-bahai-holidays, holiday-islamic-holidays)
(holiday-christian-holidays, holiday-hebrew-holidays)
(hebrew-holidays-4, hebrew-holidays-3, hebrew-holidays-2)
(hebrew-holidays-1, holiday-oriental-holidays)
(holiday-general-holidays):
* x-dnd.el (x-dnd-known-types):
* tool-bar.el (tool-bar):
* startup.el (site-run-file):
* shell.el (shell-dumb-shell-regexp):
* rfn-eshadow.el (file-name-shadow-tty-properties)
(file-name-shadow-properties):
* paths.el (remote-shell-program, news-directory):
* mouse.el ([C-down-mouse-3]):
* menu-bar.el (menu-bar-tools-menu):
* jka-cmpr-hook.el (jka-compr-load-suffixes)
(jka-compr-mode-alist-additions, jka-compr-compression-info-list)
(jka-compr-compression-info-list):
* isearch.el (search-whitespace-regexp):
* image-file.el (image-file-name-extensions):
* find-dired.el (find-ls-option):
* files.el (directory-listing-before-filename-regexp)
(directory-free-space-args, insert-directory-program)
(list-directory-brief-switches, magic-fallback-mode-alist)
(magic-fallback-mode-alist, auto-mode-interpreter-regexp)
(automount-dir-prefix):
* faces.el (face-x-resources, x-font-regexp, x-font-regexp-head)
(x-font-regexp-slant, x-font-regexp-weight, face-x-resources)
(face-font-registry-alternatives, face-font-registry-alternatives)
(face-font-family-alternatives):
* facemenu.el (facemenu-add-new-face, facemenu-background-menu)
(facemenu-foreground-menu, facemenu-face-menu):
* epa-hook.el (epa-file-name-regexp):
* dnd.el (dnd-protocol-alist):
* textmodes/rst.el (auto-mode-alist):
* button.el (default-button): Purecopy strings.
author | Dan Nicolaescu <dann@ics.uci.edu> |
---|---|
date | Fri, 06 Nov 2009 05:16:23 +0000 |
parents | a9dc0e7c3f2b |
children | 1d1d5d9bd884 |
line wrap: on
line source
;;; helper.el --- utility help package supporting help in electric modes ;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005, ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc. ;; Author: K. Shane Hartman ;; Maintainer: FSF ;; Keywords: help ;; 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 3 of the License, 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. If not, see <http://www.gnu.org/licenses/>. ;;; Commentary: ;;; Code: ;; hey, here's a helping hand. ;; Bind this to a string for <blank> in "... Other keys <blank>". ;; Helper-help uses this to construct help string when scrolling. ;; Defaults to "return" (defvar Helper-return-blurb nil) ;; Keymap implementation doesn't work too well for non-standard loops. ;; But define it anyway for those who can use it. Non-standard loops ;; will probably have to use Helper-help. You can't autoload the ;; keymap either. (defvar Helper-help-map nil) (if Helper-help-map nil (setq Helper-help-map (make-keymap)) ;(fillarray Helper-help-map 'undefined) (define-key Helper-help-map "m" 'Helper-describe-mode) (define-key Helper-help-map "b" 'Helper-describe-bindings) (define-key Helper-help-map "c" 'Helper-describe-key-briefly) (define-key Helper-help-map "k" 'Helper-describe-key) ;(define-key Helper-help-map "f" 'Helper-describe-function) ;(define-key Helper-help-map "v" 'Helper-describe-variable) (define-key Helper-help-map "?" 'Helper-help-options) (define-key Helper-help-map (char-to-string help-char) 'Helper-help-options) (fset 'Helper-help-map Helper-help-map)) (defun Helper-help-scroller () (let ((blurb (or (and (boundp 'Helper-return-blurb) Helper-return-blurb) "return"))) (save-window-excursion (goto-char (window-start (selected-window))) (if (get-buffer-window "*Help*") (pop-to-buffer "*Help*") (switch-to-buffer "*Help*")) (goto-char (point-min)) (let ((continue t) state) (while continue (setq state (+ (* 2 (if (pos-visible-in-window-p (point-max)) 1 0)) (if (pos-visible-in-window-p (point-min)) 1 0))) (message (nth state '("Space forward, Delete back. Other keys %s" "Space scrolls forward. Other keys %s" "Delete scrolls back. Other keys %s" "Type anything to %s")) blurb) (setq continue (read-event)) (cond ((and (memq continue '(?\s ?\C-v)) (< state 2)) (scroll-up)) ((= continue ?\C-l) (recenter)) ((and (= continue ?\177) (zerop (% state 2))) (scroll-down)) (t (setq continue nil)))))))) (defun Helper-help-options () "Describe help options." (interactive) (message "c (key briefly), m (mode), k (key), b (bindings)") ;(message "c (key briefly), m (mode), k (key), v (variable), f (function)") (sit-for 4)) (defun Helper-describe-key-briefly (key) "Briefly describe binding of KEY." (interactive "kDescribe key briefly: ") (describe-key-briefly key) (sit-for 4)) (defun Helper-describe-key (key) "Describe binding of KEY." (interactive "kDescribe key: ") (save-window-excursion (describe-key key)) (Helper-help-scroller)) (defun Helper-describe-function () "Describe a function. Name read interactively." (interactive) (save-window-excursion (call-interactively 'describe-function)) (Helper-help-scroller)) (defun Helper-describe-variable () "Describe a variable. Name read interactively." (interactive) (save-window-excursion (call-interactively 'describe-variable)) (Helper-help-scroller)) (defun Helper-describe-mode () "Describe the current mode." (interactive) (let ((name (format-mode-line mode-name)) (documentation (documentation major-mode))) (with-current-buffer (get-buffer-create "*Help*") (setq buffer-read-only nil) (erase-buffer) (insert name " Mode\n" documentation) (help-mode))) (Helper-help-scroller)) ;;;###autoload (defun Helper-describe-bindings () "Describe local key bindings of current mode." (interactive) (message "Making binding list...") (save-window-excursion (describe-bindings)) (Helper-help-scroller)) ;;;###autoload (defun Helper-help () "Provide help for current mode." (interactive) (let ((continue t) c) (while continue (message "Help (Type ? for further options)") (setq c (read-key-sequence nil)) (setq c (lookup-key Helper-help-map c)) (cond ((eq c 'Helper-help-options) (Helper-help-options)) ((commandp c) (call-interactively c) (setq continue nil)) (t (ding) (setq continue nil)))))) (provide 'helper) ;; arch-tag: a0984577-d3e9-4124-ae0d-c46fe740f6a9 ;;; helper.el ends here