Mercurial > emacs
view lisp/ehelp.el @ 4872:628cbf7e7005
(comint-after-partial-file-name-command):
Renamed from comint-after-partial-pathname-command.
(comint-match-partial-file-name, comint-after-partial-file-name):
Renamed from comint-match-partial-pathname, etc.
(comint-last-output-start): New variable to record
where most recent process output started from.
(comint-mode): Initialise it.
(comint-output-filter): Set it.
(comint-previous-matching-input-string): Moved to
comint-previous-matching-input-position.
(comint-previous-matching-input-string): Use it.
(comint-search-arg, comint-search-start,
comint-previous-input-string): New subroutines.
(comint-previous-input, comint-next-input,
comint-previous-matching-input, comint-next-matching-input,
comint-previous-matching-input-from-input,
comint-next-matching-input-from-input): Use them.
(comint-mode-map): Added signal menu-bar. Moved
comint-backward/forward-matching-input to output menu-bar, since
they move within the buffer rather than do input.
(comint-send-input, comint-after-pmark-p,
comint-kill-input, comint-proc-query): Removed serialisation of
obtaining the process mark's marker-position.
Commented out comint-load-hooks.
(comint-dynamic-simple-complete): New subroutine.
(comint-dynamic-complete-filename-command): New variable.
(comint-after-partial-pathname-command): New variable.
(comint-after-partial-pathname): New subroutine.
(comint-dynamic-complete): Use them.
(comint-mode): Make them local.
Renamed comint-dynamic-complete-command to
comint-dynamic-complete-command-command for consistency.
Renamed comint-file-name-addsuffix/autolist/recexact to
comint-completion-addsuffix/autolist/recexact for consistency.
(comint-replace-by-expanded-history): Check if input
ring size is not big enough for relative reference.
(comint-read-input-ring, comint-input-ring-file-name):
From shell.el.
(shell-write-input-ring): New subroutine.
(comint-file-name-prefix): New variable.
(comint-directory): New inline subroutine.
(comint-dynamic-complete-filename, comint-dynamic-complete-variable,
comint-dynamic-list-filename-completions): Use it.
(comint-dynamic-complete-filename,
comint-dynamic-complete-variable,
comint-dynamic-list-filename-completions): Make sure local
completion-ignore-case is nil.
(comint-next-prompt, comint-previous-prompt): Use
paragraph-start and paragraph motion commands rather than
re-search-forward and re-search-backward commands.
(comint-dynamic-list-input-ring,
comint-previous-matching-input-string): Use ring-empty-p rather
than zerop and ring-length.
(comint-input-ignoredups): New variable.
(comint-send-input, shell-read-input-ring): Use it.
(comint-mode): Make comint-input-ignoredups local. Doc fix.
(comint-scroll-to-bottom-on-input): New variable.
(comint-scroll-to-bottom-on-output): New variable.
(comint-scroll-show-maximum-output): New variable.
(comint-output-filter-hook): New variable, defaults to
comint-postoutput-scroll-to-bottom.
(comint-output-filter): Renamed from comint-filter
for consistency. Now calls comint-output-filter-hook.
(comint-preinput-scroll-to-bottom): New subroutine.
(comint-postoutput-scroll-to-bottom): New subroutine.
(comint-show-maximum-output): New command.
(comint-copy-old-input): New command.
(comint-send-input): Run comint-output-filter-hook if
necessary as a kludge to prevent messy redisplays.
(comint-mode-map): Added comint-show-maximum-output to
C-c C-e and menu-bar output, and comint-copy-old-input to C-c C-i
and menu-bar input.
(comint-mode): Make local variables
comint-scroll-to-bottom-on-input, before-change-function,
comint-scroll-to-bottom-on-output, comint-scroll-show-maximum-output,
and comint-output-filter-hook.
(comint-version): Deleted--no need for separate version.
(comint-input-ring-index): Make this a permanent local.
(comint-mode): Don't alter comint-input-ring-index or comint-input-ring
if already set meaningfully.
(comint-mode-map): Added keys M-R/S for
comint-previous/next-matching-input-from-input and to completion
menu-bar. Added comint-forward/backward-matching-input and
comint-previous/next-matching-input to completion menu-bar.
(comint-mode): Doc fix for functionality.
(comint-exec-1): Uses setenv.
(comint-update-env): Removed.
(comint-input-ring-size): Incremented to 32, as with
command history.
(comint-dynamic-list-input-ring): Check for zero
length ring. Use ring length, not ring size, when generating
list. Use buffer " *Input History*".
(comint-previous-matching-input-string): Check for zero-length ring.
Check last item in case at end of cycle and it's a match.
(comint-searching-input-ring): New subroutine.
(comint-regexp-arg): New subroutine.
(comint-previous-matching-input-from-input): New command.
(comint-next-matching-input-from-input): New command.
(comint-replace-by-expanded-history): Fix for matching
inside quotes. Fix to allow argument subrange specifiers. Fix to
identify and reject absolute input number references.
(comint-within-quotes): New subroutine.
(comint-how-many-region): New subroutine.
(comint-args): New subroutine.
(comint-delim-arg): New subroutine.
(comint-arguments): New subroutine.
(comint-delimiter-argument-list): New variable.
(comint-send-input): Inserts input arguments into ring
separated by single spaces.
(comint-filter): Checks the buffer's process to make
sure it's still there. Otherwise, set-buffer will fail.
(comint-backward-matching-input): New command.
(comint-forward-matching-input): New command.
(comint-next-prompt, comint-previous-prompt):
Error if reach beg/end of buffer.
(comint-dynamic-complete): Fix for absolute input
number references.
(comint-dynamic-complete-filename): Changed listings
function to comint-dynamic-list-filename-completions. Uses
file-directory-p rather than string-match to test for directories.
(comint-dynamic-list-completions): Changed to list the
list of completions supplied as the function argument. Use buffer
" *Completions*".
(comint-match-partial-pathname): New subroutine.
(comint-dynamic-complete-variable): New command.
(comint-dynamic-list-filename-completions): New function.
(comint-previous-input):
Don't use replace-match; just insert before deleting.
(comint-magic-space): Use self-insert command.
(comint-history-file-name): New variable.
(comint-mode): Initialize comint-input-ring before
running comint-mode-hook.
(comint-input-autoexpand): New variable.
(comint-dynamic-complete-command): New variable.
(comint-get-current-command): New variable.
(comint-read-input-ring): New function.
(comint-send-input): Handle history expansion.
(comint-input-sentinel): Doc fix.
(comint-mode-map): Added key binding for C-c C-h.
Added menu bars for completion, input and output.
(comint-dynamic-list-input-ring): New function.
(comint-previous-input-string): New subroutine.
(comint-previous-input): Use it.
(comint-previous-matching-input-string): New subroutine.
(comint-previous-matching-input): Use it.
(comint-replace-by-expanded-history): New command.
(comint-magic-space): New command.
(comint-replace-by-expanded-filename): Now replaces
expanded match for a filename, and then calls filename completion
comint-dynamic-complete-filename to do file name completion.
(comint-kill-output): Don't kill prompt.
(comint-show-output): Don't move point if it's
visible where it is, and if point is moved, put it after prompt.
(comint-dynamic-complete): Totally new definition.
(comint-dynamic-complete-filename): New name for old
function comint-dynamic-complete, completes files and lists
candidates, souped up for configurability.
(comint-dynamic-complete-variable): New command.
(comint-file-name-autolist): New variable.
(comint-file-name-addsuffix): New variable,
(comint-file-name-recexact): New variable.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 22 Oct 1993 02:57:36 +0000 |
parents | 9fab557f1e16 |
children | 45c4759f286e |
line wrap: on
line source
;;; ehelp.el --- bindings for electric-help mode ;; Copyright (C) 1986 Free Software Foundation, Inc. ;; Maintainer: FSF ;; Keywords: help, extensions ;; 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, 675 Mass Ave, Cambridge, MA 02139, USA. ;;; Commentary: ;; This package provides a pre-packaged `Electric Help Mode' for ;; browsing on-line help screens. There is one entry point, ;; `with-electric-help'; All you have to give it is a no-argument ;; function that generates the actual text of the help into the current ;; buffer. ;;; Code: (require 'electric) (defvar electric-help-map () "Keymap defining commands available in `electric-help-mode'.") (put 'electric-help-undefined 'suppress-keymap t) (if electric-help-map () (let ((map (make-keymap))) (fillarray (car (cdr map)) 'electric-help-undefined) (define-key map (char-to-string meta-prefix-char) (copy-keymap map)) (define-key map (char-to-string help-char) 'electric-help-help) (define-key map "?" 'electric-help-help) (define-key map " " 'scroll-up) (define-key map "\^?" 'scroll-down) (define-key map "." 'beginning-of-buffer) (define-key map "<" 'beginning-of-buffer) (define-key map ">" 'end-of-buffer) ;(define-key map "\C-g" 'electric-help-exit) (define-key map "q" 'electric-help-exit) (define-key map "Q" 'electric-help-exit) ;;a better key than this? (define-key map "r" 'electric-help-retain) (setq electric-help-map map))) (defun electric-help-mode () "`with-electric-help' temporarily places its buffer in this mode. \(On exit from `with-electric-help', the buffer is put in `default-major-mode'.)" (setq buffer-read-only t) (setq mode-name "Help") (setq major-mode 'help) (setq mode-line-buffer-identification '(" Help: %b")) (use-local-map electric-help-map) ;; this is done below in with-electric-help ;(run-hooks 'electric-help-mode-hook) ) (defun with-electric-help (thunk &optional buffer noerase) "Arguments are THUNK &optional BUFFER NOERASE. BUFFER defaults to \"*Help*\" THUNK is a function of no arguments which is called to initialize the contents of BUFFER. BUFFER will be erased before THUNK is called unless NOERASE is non-nil. THUNK will be called with `standard-output' bound to the buffer specified by BUFFER After THUNK has been called, this function \"electrically\" pops up a window in which BUFFER is displayed and allows the user to scroll through that buffer in electric-help-mode. When the user exits (with `electric-help-exit', or otherwise) the help buffer's window disappears (i.e., we use `save-window-excursion') BUFFER is put into `default-major-mode' (or `fundamental-mode') when we exit" (setq buffer (get-buffer-create (or buffer "*Help*"))) (let ((one (one-window-p t)) (config (current-window-configuration)) (bury nil)) (unwind-protect (save-excursion (if one (goto-char (window-start (selected-window)))) (let ((pop-up-windows t)) (pop-to-buffer buffer)) (save-excursion (set-buffer buffer) (electric-help-mode) (setq buffer-read-only nil) (or noerase (erase-buffer))) (let ((standard-output buffer)) (if (not (funcall thunk)) (progn (set-buffer buffer) (set-buffer-modified-p nil) (goto-char (point-min)) (if one (shrink-window-if-larger-than-buffer (selected-window)))))) (set-buffer buffer) (run-hooks 'electric-help-mode-hook) (if (eq (car-safe (electric-help-command-loop)) 'retain) (setq config (current-window-configuration)) (setq bury t))) (message "") (set-buffer buffer) (setq buffer-read-only nil) (condition-case () (funcall (or default-major-mode 'fundamental-mode)) (error nil)) (set-window-configuration config) (if bury (progn ;;>> Perhaps this shouldn't be done. ;; so that when we say "Press space to bury" we mean it (replace-buffer-in-windows buffer) ;; must do this outside of save-window-excursion (bury-buffer buffer)))))) (defun electric-help-command-loop () (catch 'exit (if (pos-visible-in-window-p (point-max)) (progn (message "<<< Press Space to bury the help buffer >>>") (if (equal (setq unread-command-events (list (read-event))) '(?\ )) (progn (setq unread-command-events nil) (throw 'exit t))))) (let (up down both neither (standard (and (eq (key-binding " ") 'scroll-up) (eq (key-binding "\^?") 'scroll-down) (eq (key-binding "Q") 'electric-help-exit) (eq (key-binding "q") 'electric-help-exit)))) (Electric-command-loop 'exit (function (lambda () (let ((min (pos-visible-in-window-p (point-min))) (max (pos-visible-in-window-p (point-max)))) (cond ((and min max) (cond (standard "Press Q to exit ") (neither) (t (setq neither (substitute-command-keys "Press \\[scroll-up] to exit "))))) (min (cond (standard "Press SPC to scroll, Q to exit ") (up) (t (setq up (substitute-command-keys "Press \\[scroll-up] to scroll; \\[electric-help-exit] to exit "))))) (max (cond (standard "Press DEL to scroll back, Q to exit ") (down) (t (setq down (substitute-command-keys "Press \\[scroll-down] to scroll back, \\[scroll-up] to exit "))))) (t (cond (standard "Press SPC to scroll, DEL to scroll back, Q to exit ") (both) (t (setq both (substitute-command-keys "Press \\[scroll-up] to scroll, \\[scroll-down] to scroll back, \\[electric-help-exit] to exit "))))))))) t)))) ;(defun electric-help-scroll-up (arg) ; ">>>Doc" ; (interactive "P") ; (if (and (null arg) (pos-visible-in-window-p (point-max))) ; (electric-help-exit) ; (scroll-up arg))) (defun electric-help-exit () ">>>Doc" (interactive) (throw 'exit t)) (defun electric-help-retain () "Exit `electric-help', retaining the current window/buffer configuration. \(The *Help* buffer will not be selected, but \\[switch-to-buffer-other-window] RET will select it.)" (interactive) (throw 'exit '(retain))) (defun electric-help-undefined () (interactive) (error "%s is undefined -- Press %s to exit" (mapconcat 'single-key-description (this-command-keys) " ") (if (eq (key-binding "Q") 'electric-help-exit) "Q" (substitute-command-keys "\\[electric-help-exit]")))) ;>>> this needs to be hairified (recursive help, anybody?) (defun electric-help-help () (interactive) (if (and (eq (key-binding "Q") 'electric-help-exit) (eq (key-binding " ") 'scroll-up) (eq (key-binding "\^?") 'scroll-down)) (message "SPC scrolls forward, DEL scrolls back, Q exits and burys help buffer") ;; to give something for user to look at while slow substitute-cmd-keys ;; grinds away (message "Help...") (message "%s" (substitute-command-keys "\\[scroll-up] scrolls forward, \\[scroll-down] scrolls back, \\[electric-help-exit] exits."))) (sit-for 2)) (defun electric-helpify (fun) (let ((name "*Help*")) (if (save-window-excursion ;; kludge-o-rama (let* ((p (symbol-function 'print-help-return-message)) (b (get-buffer name)) (m (buffer-modified-p b))) (and b (not (get-buffer-window b)) (setq b nil)) (unwind-protect (progn (message "%s..." (capitalize (symbol-name fun))) ;; with-output-to-temp-buffer marks the buffer as unmodified. ;; kludging excessively and relying on that as some sort ;; of indication leads to the following abomination... ;;>> This would be doable without such icky kludges if either ;;>> (a) there were a function to read the interactive ;;>> args for a command and return a list of those args. ;;>> (To which one would then just apply the command) ;;>> (The only problem with this is that interactive-p ;;>> would break, but that is such a misfeature in ;;>> any case that I don't care) ;;>> It is easy to do this for emacs-lisp functions; ;;>> the only problem is getting the interactive spec ;;>> for subrs ;;>> (b) there were a function which returned a ;;>> modification-tick for a buffer. One could tell ;;>> whether a buffer had changed by whether the ;;>> modification-tick were different. ;;>> (Presumably there would have to be a way to either ;;>> restore the tick to some previous value, or to ;;>> suspend updating of the tick in order to allow ;;>> things like momentary-string-display) (and b (save-excursion (set-buffer b) (set-buffer-modified-p t))) (fset 'print-help-return-message 'ignore) (call-interactively fun) (and (get-buffer name) (get-buffer-window (get-buffer name)) (or (not b) (not (eq b (get-buffer name))) (not (buffer-modified-p b))))) (fset 'print-help-return-message p) (and b (buffer-name b) (save-excursion (set-buffer b) (set-buffer-modified-p m)))))) (with-electric-help 'ignore name t)))) (defun electric-describe-key () (interactive) (electric-helpify 'describe-key)) (defun electric-describe-mode () (interactive) (electric-helpify 'describe-mode)) (defun electric-view-lossage () (interactive) (electric-helpify 'view-lossage)) ;(defun electric-help-for-help () ; "See help-for-help" ; (interactive) ; ) (defun electric-describe-function () (interactive) (electric-helpify 'describe-function)) (defun electric-describe-variable () (interactive) (electric-helpify 'describe-variable)) (defun electric-describe-bindings () (interactive) (electric-helpify 'describe-bindings)) (defun electric-describe-syntax () (interactive) (electric-helpify 'describe-syntax)) (defun electric-command-apropos () (interactive) (electric-helpify 'command-apropos)) ;(define-key help-map "a" 'electric-command-apropos) ;;;; ehelp-map (defvar ehelp-map ()) (if ehelp-map nil (let ((map (copy-keymap help-map))) (substitute-key-definition 'describe-key 'electric-describe-key map) (substitute-key-definition 'describe-mode 'electric-describe-mode map) (substitute-key-definition 'view-lossage 'electric-view-lossage map) (substitute-key-definition 'describe-function 'electric-describe-function map) (substitute-key-definition 'describe-variable 'electric-describe-variable map) (substitute-key-definition 'describe-bindings 'electric-describe-bindings map) (substitute-key-definition 'describe-syntax 'electric-describe-syntax map) (setq ehelp-map map) (fset 'ehelp-command map))) ;; Do (define-key global-map "\C-h" 'ehelp-command) if you want to win (provide 'ehelp) ;;; ehelp.el ends here