Implement bidi-sensitive movement with arrow keys.
[bpt/emacs.git] / lisp / bindings.el
index 818467e..14cebfe 100644 (file)
@@ -1,7 +1,8 @@
 ;;; bindings.el --- define standard key bindings and some variables
 
 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996, 1999,
-;;   2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;;   2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
+;;   Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: internal
 
 ;;; Commentary:
 
-;;; !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-;;; Special formatting conventions are used in this file!
-;;;
-;;; A backslash-newline is used at the beginning of a documentation string
-;;; when that string should be stored in the file etc/DOCnnn, not in core.
-;;;
-;;; Such strings read into Lisp as numbers (during the pure-loading phase).
-;;;
-;;; But you must obey certain rules to make sure the string is understood
-;;; and goes into etc/DOCnnn properly.
-;;;
-;;; The doc string must appear in the standard place in a call to
-;;; defun, autoload, defvar or defconst.  No Lisp macros are recognized.
-;;; The open-paren starting the definition must appear in column 0.
-;;;
-;;; In defvar and defconst, there is an additional rule:
-;;; The double-quote that starts the string must be on the same
-;;; line as the defvar or defconst.
-;;; !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
 ;;; Code:
 
 (defun make-mode-line-mouse-map (mouse function) "\
@@ -81,24 +62,6 @@ corresponding to the mode line clicked."
     (force-mode-line-update)))
 
 
-(defun mode-line-abbrev-mode (event)
-  "Turn off `abbrev-mode' from the mode-line."
-  (interactive "e")
-  (save-selected-window
-    (select-window (posn-window (event-start event)))
-    (abbrev-mode)
-    (force-mode-line-update)))
-
-
-(defun mode-line-auto-fill-mode (event)
-  "Turn off `auto-fill-mode' from the mode-line."
-  (interactive "e")
-  (save-selected-window
-    (select-window (posn-window (event-start event)))
-    (auto-fill-mode)
-    (force-mode-line-update)))
-
-
 (defvar mode-line-input-method-map
   (let ((map (make-sparse-keymap)))
     (define-key map [mode-line mouse-2]
@@ -146,7 +109,7 @@ corresponding to the mode line clicked."
 (defun mode-line-eol-desc ()
   (let* ((eol (coding-system-eol-type buffer-file-coding-system))
         (mnemonic (coding-system-eol-type-mnemonic buffer-file-coding-system))
-        (desc (assq eol mode-line-eol-desc-cache)))
+        (desc (assoc eol mode-line-eol-desc-cache)))
     (if (and desc (eq (cadr desc) mnemonic))
        (cddr desc)
       (if desc (setq mode-line-eol-desc-cache nil)) ;Flush the cache if stale.
@@ -155,7 +118,7 @@ corresponding to the mode line clicked."
             mnemonic
             'help-echo (format "End-of-line style: %s\nmouse-1 to cycle"
                                (if (eq eol 0) "Unix-style LF"
-                                 (if (eq eol 1) "Dos-style CRLF"
+                                 (if (eq eol 1) "DOS-style CRLF"
                                    (if (eq eol 2) "Mac-style CR"
                                      "Undecided"))))
             'keymap
@@ -170,19 +133,21 @@ corresponding to the mode line clicked."
 (defvar mode-line-client
   `(""
     (:propertize ("" (:eval (if (frame-parameter nil 'client) "@" "")))
-                help-echo "Emacsclient frame"))
-  "Mode-line control for identifying Emacsclient frames.")
+                help-echo ,(purecopy "emacsclient frame")))
+  "Mode-line control for identifying emacsclient frames.")
+;;;###autoload
+(put 'mode-line-client 'risky-local-variable t)
 
 (defvar mode-line-mule-info
   `(""
     (current-input-method
      (:propertize ("" current-input-method-title)
                  help-echo (concat
-                            "Current input method: "
+                            ,(purecopy "Current input method: ")
                             current-input-method
-                            "\n\
+                            ,(purecopy "\n\
 mouse-2: Disable input method\n\
-mouse-3: Describe current input method")
+mouse-3: Describe current input method"))
                  local-map ,mode-line-input-method-map
                  mouse-face mode-line-highlight))
     ,(propertize
@@ -213,25 +178,32 @@ mnemonics of the following coding systems:
   ;;  coding system for encoding text to send to buffer process (if any)."
 )
 
+;;;###autoload
+(put 'mode-line-mule-info 'risky-local-variable t)
 (make-variable-buffer-local 'mode-line-mule-info)
 
 ;; MSDOS frames have window-system, but want the Fn identification.
 (defun mode-line-frame-control ()
   "Compute mode-line control for frame identification.
 Value is used for `mode-line-frame-identification', which see."
-  (if (or (null (window-system))
-         (eq (window-system) 'pc))
+  (if (or (null window-system)
+         (eq window-system 'pc))
       "-%F  "
     "  "))
 
-(defvar mode-line-frame-identification
-  (list (mode-line-frame-control))
+;; We need to defer the call to mode-line-frame-control to the time
+;; the mode line is actually displayed.
+(defvar mode-line-frame-identification '(:eval (mode-line-frame-control))
   "Mode-line control to describe the current frame.")
+;;;###autoload
+(put 'mode-line-frame-identification 'risky-local-variable t)
 
 (defvar mode-line-process nil "\
 Mode-line control for displaying info on process status.
 Normally nil in most modes, since there is no process to display.")
 
+;;;###autoload
+(put 'mode-line-process 'risky-local-variable t)
 (make-variable-buffer-local 'mode-line-process)
 
 (defvar mode-line-modified
@@ -255,13 +227,15 @@ Normally nil in most modes, since there is no process to display.")
                                         (save-selected-window
                                           (select-window window)
                                           (if (buffer-modified-p)
-                                            "M"
-                                          "Not m")))))
+                                            "m"
+                                          "not m")))))
         'local-map (purecopy (make-mode-line-mouse-map
                               'mouse-1 #'mode-line-toggle-modified))
         'mouse-face 'mode-line-highlight))
   "Mode-line control for displaying whether current buffer is modified.")
 
+;;;###autoload
+(put 'mode-line-modified 'risky-local-variable t)
 (make-variable-buffer-local 'mode-line-modified)
 
 (defvar mode-line-remote
@@ -278,6 +252,8 @@ Normally nil in most modes, since there is no process to display.")
                                             "Current directory is local: ")
                                           default-directory)))))))
   "Mode-line flag to show if default-directory for current buffer is remote.")
+;;;###autoload
+(put 'mode-line-remote 'risky-local-variable t)
 
 (make-variable-buffer-local 'mode-line-remote)
 
@@ -286,9 +262,13 @@ Normally nil in most modes, since there is no process to display.")
   "Mode-line control for displaying the position in the buffer.
 Normally displays the buffer percentage and, optionally, the
 buffer size, the line number and the column number.")
+;;;###autoload
+(put 'mode-line-position 'risky-local-variable t)
 
 (defvar mode-line-modes nil
   "Mode-line control for displaying major and minor modes.")
+;;;###autoload
+(put 'mode-line-modes 'risky-local-variable t)
 
 (defvar mode-line-mode-menu (make-sparse-keymap "Minor Modes") "\
 Menu of mode operations in the mode line.")
@@ -296,7 +276,7 @@ Menu of mode operations in the mode line.")
 (defvar mode-line-major-mode-keymap
   (let ((map (make-sparse-keymap)))
     (define-key map [mode-line down-mouse-1]
-      '(menu-item "Menu Bar" ignore
+      `(menu-item ,(purecopy "Menu Bar") ignore
         :filter (lambda (_) (mouse-menu-major-mode-map))))
     (define-key map [mode-line mouse-2] 'describe-mode)
     (define-key map [mode-line down-mouse-3] mode-line-mode-menu)
@@ -317,11 +297,11 @@ Keymap to display on minor modes.")
        (menu-map (make-sparse-keymap "Toggle Line and Column Number Display")))
     (define-key menu-map [line-number-mode]
       `(menu-item ,(purecopy "Display Line Numbers") line-number-mode
-                 :help "Toggle displaying line numbers in the mode-line"
+                 :help ,(purecopy "Toggle displaying line numbers in the mode-line")
                  :button (:toggle . line-number-mode)))
     (define-key menu-map [column-number-mode]
       `(menu-item ,(purecopy "Display Column Numbers") column-number-mode
-                 :help "Toggle displaying column numbers in the mode-line"
+                 :help ,(purecopy "Toggle displaying column numbers in the mode-line")
                  :button (:toggle . column-number-mode)))
     (define-key map [mode-line down-mouse-1] menu-map)
     map) "\
@@ -354,7 +334,7 @@ mouse-3: Remove current window from display")
         (propertize "  " 'help-echo help-echo)
         'mode-line-modes
         `(which-func-mode ("" which-func-format ,dashes))
-        `(global-mode-string (,dashes global-mode-string))
+        `(global-mode-string ("" global-mode-string ,dashes))
         (propertize "-%-" 'help-echo help-echo)))
        (standard-mode-line-modes
        (list
@@ -467,6 +447,8 @@ Its default value is (\"%12b\") with some text properties added.
 Major modes that edit things other than ordinary files may change this
 \(e.g. Info, Dired,...)")
 
+;;;###autoload
+(put 'mode-line-buffer-identification 'risky-local-variable t)
 (make-variable-buffer-local 'mode-line-buffer-identification)
 
 (defun unbury-buffer () "\
@@ -515,49 +497,49 @@ Switch to the most recently selected buffer other than the current one."
 ;; Global ones can go on the menubar (Options --> Show/Hide).
 (define-key mode-line-mode-menu [overwrite-mode]
   `(menu-item ,(purecopy "Overwrite (Ovwrt)") overwrite-mode
-             :help "Overwrite mode: typed characters replace existing text"
+             :help ,(purecopy "Overwrite mode: typed characters replace existing text")
              :button (:toggle . overwrite-mode)))
 (define-key mode-line-mode-menu [outline-minor-mode]
   `(menu-item ,(purecopy "Outline (Outl)") outline-minor-mode
              ;; XXX: This needs a good, brief description.
-             :help ""
+             :help ,(purecopy "")
              :button (:toggle . (bound-and-true-p outline-minor-mode))))
 (define-key mode-line-mode-menu [highlight-changes-mode]
   `(menu-item ,(purecopy "Highlight changes (Chg)") highlight-changes-mode
-             :help "Show changes in the buffer in a distinctive color"
+             :help ,(purecopy "Show changes in the buffer in a distinctive color")
              :button (:toggle . (bound-and-true-p highlight-changes-mode))))
 (define-key mode-line-mode-menu [hide-ifdef-mode]
   `(menu-item ,(purecopy "Hide ifdef (Ifdef)") hide-ifdef-mode
-             :help "Show/Hide code within #ifdef constructs"
+             :help ,(purecopy "Show/Hide code within #ifdef constructs")
              :button (:toggle . (bound-and-true-p hide-ifdef-mode))))
 (define-key mode-line-mode-menu [glasses-mode]
   `(menu-item ,(purecopy "Glasses (o^o)") glasses-mode
-             :help "Insert virtual separators to make long identifiers easy to read"
+             :help ,(purecopy "Insert virtual separators to make long identifiers easy to read")
              :button (:toggle . (bound-and-true-p glasses-mode))))
 (define-key mode-line-mode-menu [font-lock-mode]
   `(menu-item ,(purecopy "Font Lock") font-lock-mode
-             :help "Syntax coloring"
+             :help ,(purecopy "Syntax coloring")
              :button (:toggle . font-lock-mode)))
 (define-key mode-line-mode-menu [flyspell-mode]
   `(menu-item ,(purecopy "Flyspell (Fly)") flyspell-mode
-             :help "Spell checking on the fly"
+             :help ,(purecopy "Spell checking on the fly")
              :button (:toggle . (bound-and-true-p flyspell-mode))))
 (define-key mode-line-mode-menu [auto-revert-tail-mode]
   `(menu-item ,(purecopy "Auto revert tail (Tail)") auto-revert-tail-mode
-             :help "Revert the tail of the buffer when buffer grows"
+             :help ,(purecopy "Revert the tail of the buffer when buffer grows")
              :enable (buffer-file-name)
              :button (:toggle . (bound-and-true-p auto-revert-tail-mode))))
 (define-key mode-line-mode-menu [auto-revert-mode]
   `(menu-item ,(purecopy "Auto revert (ARev)") auto-revert-mode
-             :help "Revert the buffer when the file on disk changes"
+             :help ,(purecopy "Revert the buffer when the file on disk changes")
              :button (:toggle . (bound-and-true-p auto-revert-mode))))
 (define-key mode-line-mode-menu [auto-fill-mode]
   `(menu-item ,(purecopy "Auto fill (Fill)") auto-fill-mode
-             :help "Automatically insert new lines"
+             :help ,(purecopy "Automatically insert new lines")
              :button (:toggle . auto-fill-function)))
 (define-key mode-line-mode-menu [abbrev-mode]
   `(menu-item ,(purecopy "Abbrev (Abbrev)") abbrev-mode
-             :help "Automatically expand abbreviations"
+             :help ,(purecopy "Automatically expand abbreviations")
              :button (:toggle . abbrev-mode)))
 
 (defun mode-line-minor-mode-help (event)
@@ -573,6 +555,8 @@ STRING is included in the mode line if VARIABLE's value is non-nil.
 
 Actually, STRING need not be a string; any possible mode-line element
 is okay.  See `mode-line-format'.")
+;;;###autoload
+(put 'minor-mode-alist 'risky-local-variable t)
 ;; Don't use purecopy here--some people want to change these strings.
 (setq minor-mode-alist
       '((abbrev-mode " Abbrev")
@@ -591,13 +575,18 @@ is okay.  See `mode-line-format'.")
 (setq completion-ignored-extensions
       (append
        (cond ((memq system-type '(ms-dos windows-nt))
+             (mapcar 'purecopy
              '(".o" "~" ".bin" ".bak" ".obj" ".map" ".ico" ".pif" ".lnk"
-               ".a" ".ln" ".blg" ".bbl" ".dll" ".drv" ".vxd" ".386"))
+               ".a" ".ln" ".blg" ".bbl" ".dll" ".drv" ".vxd" ".386")))
             (t
+             (mapcar 'purecopy
              '(".o" "~" ".bin" ".lbin" ".so"
-               ".a" ".ln" ".blg" ".bbl")))
+               ".a" ".ln" ".blg" ".bbl"))))
+       (mapcar 'purecopy
        '(".elc" ".lof"
         ".glo" ".idx" ".lot"
+        ;; VCS metadata directories
+        ".svn/" ".hg/" ".git/" ".bzr/" "CVS/" "_darcs/" "_MTN/"
         ;; TeX-related
         ".fmt" ".tfm"
         ;; Java compiled
@@ -620,7 +609,7 @@ is okay.  See `mode-line-format'.")
         ".cp" ".fn" ".ky" ".pg" ".tp" ".vr"
         ".cps" ".fns" ".kys" ".pgs" ".tps" ".vrs"
         ;; Python byte-compiled
-        ".pyc" ".pyo")))
+        ".pyc" ".pyo"))))
 
 ;; Suffixes used for executables.
 (setq exec-suffixes
@@ -633,24 +622,24 @@ is okay.  See `mode-line-format'.")
 ;; Packages should add to this list appropriately when they are
 ;; loaded, rather than listing everything here.
 (setq debug-ignored-errors
-      '(beginning-of-line beginning-of-buffer end-of-line
+      `(beginning-of-line beginning-of-buffer end-of-line
        end-of-buffer end-of-file buffer-read-only
        file-supersession
-       "^Previous command was not a yank$"
-       "^Minibuffer window is not active$"
-       "^No previous history search regexp$"
-       "^No later matching history item$"
-       "^No earlier matching history item$"
-       "^End of history; no default available$"
-       "^End of defaults; no next item$"
-       "^Beginning of history; no preceding item$"
-       "^No recursive edit is in progress$"
-       "^Changes to be undone are outside visible portion of buffer$"
-       "^No undo information in this buffer$"
-       "^No further undo information"
-       "^Save not confirmed$"
-       "^Recover-file cancelled\\.$"
-       "^Cannot switch buffers in a dedicated window$"
+       ,(purecopy "^Previous command was not a yank$")
+       ,(purecopy "^Minibuffer window is not active$")
+       ,(purecopy "^No previous history search regexp$")
+       ,(purecopy "^No later matching history item$")
+       ,(purecopy "^No earlier matching history item$")
+       ,(purecopy "^End of history; no default available$")
+       ,(purecopy "^End of defaults; no next item$")
+       ,(purecopy "^Beginning of history; no preceding item$")
+       ,(purecopy "^No recursive edit is in progress$")
+       ,(purecopy "^Changes to be undone are outside visible portion of buffer$")
+       ,(purecopy "^No undo information in this buffer$")
+       ,(purecopy "^No further undo information")
+       ,(purecopy "^Save not confirmed$")
+       ,(purecopy "^Recover-file cancelled\\.$")
+       ,(purecopy "^Cannot switch buffers in a dedicated window$")
         ))
 
 
@@ -664,24 +653,6 @@ is okay.  See `mode-line-format'.")
 
 (define-key esc-map "\t" 'complete-symbol)
 
-(defun complete-symbol (arg) "\
-Perform tags completion on the text around point.
-Completes to the set of names listed in the current tags table.
-The string to complete is chosen in the same way as the default
-for \\[find-tag] (which see).
-
-With a prefix argument, this command does completion within
-the collection of symbols listed in the index of the manual for the
-language you are using."
-  (interactive "P")
-  (if arg
-      (info-complete-symbol)
-    (if (fboundp 'complete-tag)
-       (complete-tag)
-      ;; Don't autoload etags if we have no tags table.
-      (error "%s" (substitute-command-keys
-             "No tags table loaded; use \\[visit-tags-table] to load one")))))
-
 ;; Reduce total amount of space we must allocate during this function
 ;; that we will not need to keep permanently.
 (garbage-collect)
@@ -742,7 +713,8 @@ language you are using."
 (define-key ctl-x-map "\e\e" 'repeat-complex-command)
 ;; New binding analogous to M-:.
 (define-key ctl-x-map "\M-:" 'repeat-complex-command)
-(define-key ctl-x-map "u" 'advertised-undo)
+(define-key ctl-x-map "u" 'undo)
+(put 'undo :advertised-binding [?\C-x ?u])
 ;; Many people are used to typing C-/ on X terminals and getting C-_.
 (define-key global-map [?\C-/] 'undo)
 (define-key global-map "\C-_" 'undo)
@@ -752,6 +724,7 @@ language you are using."
 
 (define-key esc-map "!" 'shell-command)
 (define-key esc-map "|" 'shell-command-on-region)
+(define-key esc-map "&" 'async-shell-command)
 
 (define-key ctl-x-map [right] 'next-buffer)
 (define-key ctl-x-map [C-right] 'next-buffer)
@@ -855,12 +828,12 @@ language you are using."
 (define-key global-map [C-home]                'beginning-of-buffer)
 (define-key global-map [M-home]                'beginning-of-buffer-other-window)
 (define-key esc-map    [home]          'beginning-of-buffer-other-window)
-(define-key global-map [left]          'backward-char)
+(define-key global-map [left]          'left-arrow-command)
 (define-key global-map [up]            'previous-line)
-(define-key global-map [right]         'forward-char)
+(define-key global-map [right]         'right-arrow-command)
 (define-key global-map [down]          'next-line)
-(define-key global-map [prior]         'scroll-down)
-(define-key global-map [next]          'scroll-up)
+(define-key global-map [prior]         'scroll-down-command)
+(define-key global-map [next]          'scroll-up-command)
 (define-key global-map [C-up]          'backward-paragraph)
 (define-key global-map [C-down]                'forward-paragraph)
 (define-key global-map [C-prior]       'scroll-right)
@@ -964,6 +937,9 @@ language you are using."
 
 ;; X11R6 distinguishes these keys from the non-kp keys.
 ;; Make them behave like the non-kp keys unless otherwise bound.
+;; FIXME: rather than list such mappings for every modifier-combination,
+;;   we should come up with a way to do it generically, something like
+;;   (define-key function-key-map [*-kp-home] [*-home])
 (define-key function-key-map [kp-home] [home])
 (define-key function-key-map [kp-left] [left])
 (define-key function-key-map [kp-up] [up])
@@ -1014,6 +990,11 @@ language you are using."
 (define-key function-key-map [C-S-kp-8] [C-S-up])
 (define-key function-key-map [C-S-kp-9] [C-S-prior])
 
+;; Hitting C-SPC on text terminals, usually sends the ascii code 0 (aka C-@),
+;; so we can't distinguish those two keys, but usually we consider C-SPC
+;; (rather than C-@) as the "canonical" binding.
+(define-key function-key-map [?\C-@] [?\C-\s])
+
 (define-key global-map [mouse-movement] 'ignore)
 
 (define-key global-map "\C-t" 'transpose-chars)
@@ -1052,8 +1033,8 @@ language you are using."
 (global-set-key [C-right]  'forward-word)
 (global-set-key [C-left]   'backward-word)
 ;; This is not quite compatible, but at least is analogous
-(global-set-key [C-delete] 'backward-kill-word)
-(global-set-key [C-backspace] 'kill-word)
+(global-set-key [C-delete] 'kill-word)
+(global-set-key [C-backspace] 'backward-kill-word)
 ;; This is "move to the clipboard", or as close as we come.
 (global-set-key [S-delete] 'kill-region)