Mercurial > emacs
view lisp/electric.el @ 111166:6cf6c01cf9bf
Move some more shared x-, w32- things to common-win.
* term/ns-win.el (x-select-text): Doc fix.
* w32-fns.el (x-alternatives-map, x-setup-function-keys)
(x-select-text): Move to term/common-win.
* term/w32-win.el (xw-defined-colors): Move to common-win.
* term/x-win.el (xw-defined-colors, x-alternatives-map)
(x-setup-function-keys, x-select-text): Move to common-win.
* term/common-win.el (x-select-text, x-alternatives-map)
(x-setup-function-keys, xw-defined-colors): Merge x- and w32-
definitions here.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Sun, 24 Oct 2010 15:04:45 -0700 |
parents | 92e4fa270c92 |
children | e6399f46aefa |
line wrap: on
line source
;;; electric.el --- window maker and Command loop for `electric' modes ;; Copyright (C) 1985, 1986, 1995, 2001, 2002, 2003, 2004, ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. ;; Author: K. Shane Hartman ;; Maintainer: FSF ;; Keywords: 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 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: ;; "Electric" has been used in Emacs to refer to different things. ;; Among them: ;; ;; - electric modes and buffers: modes that typically pop-up in a modal kind of ;; way a transient buffer that automatically disappears as soon as the user ;; is done with it. ;; ;; - electric keys: self inserting keys which additionally perform some side ;; operation which happens to be often convenient at that time. Examples of ;; such side operations are: reindenting code, inserting a newline, ;; ... auto-fill-mode and abbrev-mode can be considered as built-in forms of ;; electric key behavior. ;;; Code: (eval-when-compile (require 'cl)) ;; This loop is the guts for non-standard modes which retain control ;; until some event occurs. It is a `do-forever', the only way out is ;; to throw. It assumes that you have set up the keymap, window, and ;; everything else: all it does is read commands and execute them - ;; providing error messages should one occur (if there is no loop ;; function - which see). The required argument is a tag which should ;; expect a value of nil if the user decides to punt. The second ;; argument is the prompt to be used: if nil, use "->", if 'noprompt, ;; don't use a prompt, if a string, use that string as prompt, and if ;; a function of no variable, it will be evaluated in every iteration ;; of the loop and its return value, which can be nil, 'noprompt or a ;; string, will be used as prompt. Given third argument non-nil, it ;; INHIBITS quitting unless the user types C-g at toplevel. This is ;; so user can do things like C-u C-g and not get thrown out. Fourth ;; argument, if non-nil, should be a function of two arguments which ;; is called after every command is executed. The fifth argument, if ;; provided, is the state variable for the function. If the ;; loop-function gets an error, the loop will abort WITHOUT throwing ;; (moral: use unwind-protect around call to this function for any ;; critical stuff). The second argument for the loop function is the ;; conditions for any error that occurred or nil if none. (defun Electric-command-loop (return-tag &optional prompt inhibit-quit loop-function loop-state) (let (cmd (err nil) (prompt-string prompt)) (while t (if (functionp prompt) (setq prompt-string (funcall prompt))) (if (not (stringp prompt-string)) (setq prompt-string (unless (eq prompt-string 'noprompt) "->"))) (setq cmd (read-key-sequence prompt-string)) (setq last-command-event (aref cmd (1- (length cmd))) this-command (key-binding cmd t) cmd this-command) ;; This makes universal-argument-other-key work. (setq universal-argument-num-events 0) (if (or (prog1 quit-flag (setq quit-flag nil)) (eq last-input-event ?\C-g)) (progn (setq unread-command-events nil prefix-arg nil) ;; If it wasn't cancelling a prefix character, then quit. (if (or (= (length (this-command-keys)) 1) (not inhibit-quit)) ; safety (progn (ding) (message "Quit") (throw return-tag nil)) (setq cmd nil)))) (setq current-prefix-arg prefix-arg) (if cmd (condition-case conditions (progn (command-execute cmd) (setq last-command this-command) (if (or (prog1 quit-flag (setq quit-flag nil)) (eq last-input-event ?\C-g)) (progn (setq unread-command-events nil) (if (not inhibit-quit) (progn (ding) (message "Quit") (throw return-tag nil)) (ding))))) (buffer-read-only (if loop-function (setq err conditions) (ding) (message "Buffer is read-only") (sit-for 2))) (beginning-of-buffer (if loop-function (setq err conditions) (ding) (message "Beginning of Buffer") (sit-for 2))) (end-of-buffer (if loop-function (setq err conditions) (ding) (message "End of Buffer") (sit-for 2))) (error (if loop-function (setq err conditions) (ding) (message "Error: %s" (if (eq (car conditions) 'error) (car (cdr conditions)) (prin1-to-string conditions))) (sit-for 2)))) (ding)) (if loop-function (funcall loop-function loop-state err)))) (ding) (throw return-tag nil)) ;; This function is like pop-to-buffer, sort of. ;; The algorithm is ;; If there is a window displaying buffer ;; Select it ;; Else if there is only one window ;; Split it, selecting the window on the bottom with height being ;; the lesser of max-height (if non-nil) and the number of lines in ;; the buffer to be displayed subject to window-min-height constraint. ;; Else ;; Switch to buffer in the current window. ;; ;; Then if max-height is nil, and not all of the lines in the buffer ;; are displayed, grab the whole frame. ;; ;; Returns selected window on buffer positioned at point-min. (defun Electric-pop-up-window (buffer &optional max-height) (let* ((win (or (get-buffer-window buffer) (selected-window))) (buf (get-buffer buffer)) (one-window (one-window-p t)) (pop-up-windows t) (pop-up-frames nil)) (if (not buf) (error "Buffer %s does not exist" buffer) (cond ((and (eq (window-buffer win) buf)) (select-window win)) (one-window (pop-to-buffer buffer) (setq win (selected-window))) (t (switch-to-buffer buf))) ;; Don't shrink the window, but expand it if necessary. (goto-char (point-min)) (unless (= (point-max) (window-end win t)) (fit-window-to-buffer win max-height)) win))) ;;; Electric keys. (defgroup electricity () "Electric behavior for self inserting keys." :group 'editing) ;; Electric indentation. (defvar electric-indent-chars '(?\n) "Characters that should cause automatic reindentation.") (defun electric-indent-post-self-insert-function () ;; FIXME: This reindents the current line, but what we really want instead is ;; to reindent the whole affected text. That's the current line for simple ;; cases, but not all cases. We do take care of the newline case in an ;; ad-hoc fashion, but there are still missing cases such as the case of ;; electric-pair-mode wrapping a region with a pair of parens. ;; There might be a way to get it working by analyzing buffer-undo-list, but ;; it looks challenging. (when (and (memq last-command-event electric-indent-chars) ;; Don't reindent while inserting spaces at beginning of line. (or (not (memq last-command-event '(?\s ?\t))) (save-excursion (skip-chars-backward " \t") (not (bolp)))) ;; Not in a string or comment. (not (nth 8 (syntax-ppss)))) ;; For newline, we want to reindent both lines and basically behave like ;; reindent-then-newline-and-indent (whose code we hence copied). (when (and (eq last-command-event ?\n) ;; Don't reindent the previous line if the indentation function ;; is not a real one. (not (memq indent-line-function '(indent-relative indent-relative-maybe))) ;; Sanity check. (eq (char-before) last-command-event)) (let ((pos (copy-marker (1- (point)) t))) (save-excursion (goto-char pos) (indent-according-to-mode) ;; We are at EOL before the call to indent-according-to-mode, and ;; after it we usually are as well, but not always. We tried to ;; address it with `save-excursion' but that uses a normal marker ;; whereas we need `move after insertion', so we do the ;; save/restore by hand. (goto-char pos) ;; Remove the trailing whitespace after indentation because ;; indentation may (re)introduce the whitespace. (delete-horizontal-space t)))) (indent-according-to-mode))) ;;;###autoload (define-minor-mode electric-indent-mode "Automatically reindent lines of code when inserting particular chars. `electric-indent-chars' specifies the set of chars that should cause reindentation." :global t :group 'electricity (if electric-indent-mode (add-hook 'post-self-insert-hook #'electric-indent-post-self-insert-function) (remove-hook 'post-self-insert-hook #'electric-indent-post-self-insert-function))) ;; Electric pairing. (defcustom electric-pair-skip-self t "If non-nil, skip char instead of inserting a second closing paren. When inserting a closing paren character right before the same character, just skip that character instead, so that hitting ( followed by ) results in \"()\" rather than \"())\". This can be convenient for people who find it easier to hit ) than C-f." :type 'boolean) (defun electric-pair-post-self-insert-function () (let* ((syntax (and (eq (char-before) last-command-event) ; Sanity check. (char-syntax last-command-event))) ;; FIXME: when inserting the closer, we should maybe use ;; self-insert-command, although it may prove tricky running ;; post-self-insert-hook recursively, and we wouldn't want to trigger ;; blink-matching-open. (closer (if (eq syntax ?\() (cdr (aref (syntax-table) last-command-event)) last-command-event))) (cond ;; Wrap a pair around the active region. ((and (memq syntax '(?\( ?\" ?\$)) (use-region-p)) (if (> (mark) (point)) (goto-char (mark)) ;; We already inserted the open-paren but at the end of the region, ;; so we have to remove it and start over. (delete-char -1) (save-excursion (goto-char (mark)) (insert last-command-event))) (insert closer)) ;; Backslash-escaped: no pairing, no skipping. ((save-excursion (goto-char (1- (point))) (not (zerop (% (skip-syntax-backward "\\") 2)))) nil) ;; Skip self. ((and (memq syntax '(?\) ?\" ?\$)) electric-pair-skip-self (eq (char-after) last-command-event)) ;; This is too late: rather than insert&delete we'd want to only skip (or ;; insert in overwrite mode). The difference is in what goes in the ;; undo-log and in the intermediate state which might be visible to other ;; post-self-insert-hook. We'll just have to live with it for now. (delete-char 1)) ;; Insert matching pair. ((not (or (not (memq syntax `(?\( ?\" ?\$))) overwrite-mode ;; I find it more often preferable not to pair when the ;; same char is next. (eq last-command-event (char-after)) (eq last-command-event (char-before (1- (point)))) ;; I also find it often preferable not to pair next to a word. (eq (char-syntax (following-char)) ?w))) (save-excursion (insert closer)))))) ;;;###autoload (define-minor-mode electric-pair-mode "Automatically pair-up parens when inserting an open paren." :global t :group 'electricity (if electric-pair-mode (add-hook 'post-self-insert-hook #'electric-pair-post-self-insert-function) (remove-hook 'post-self-insert-hook #'electric-pair-post-self-insert-function))) (provide 'electric) ;; arch-tag: dae045eb-dc2d-4fb7-9f27-9cc2ce277be8 ;;; electric.el ends here