annotate lisp/mwheel.el @ 4792:95b04754ea8c

Make #'equalp more compatible with CL; add a compiler macro, test & doc it. lisp/ChangeLog addition: 2009-11-08 Aidan Kehoe <kehoea@parhasard.net> * cl-extra.el (cl-string-vector-equalp) (cl-bit-vector-vector-equalp, cl-vector-array-equalp) (cl-hash-table-contents-equalp): New functions, to implement equalp treating arrays with identical contents as equivalent, as specified by Common Lisp. (equalp): Revise this function to implement array equivalence, and the hash-table equalp behaviour specified by CL. * cl-macs.el (equalp): Add a compiler macro for this function, used when one of the arguments is constant, and as such, its type is known at compile time. man/ChangeLog addition: 2009-11-08 Aidan Kehoe <kehoea@parhasard.net> * lispref/objects.texi (Equality Predicates): Document #'equalp here, as well as #'equal and #'eq. tests/ChangeLog addition: 2009-12-31 Aidan Kehoe <kehoea@parhasard.net> * automated/lisp-tests.el: Test much of the functionality of equalp; add a pointer to Paul Dietz' ANSI test suite for this function, converted to Emacs Lisp. Not including the tests themselves in XEmacs because who owns the copyright on the files is unclear and the GCL people didn't respond to my queries.
author Aidan Kehoe <kehoea@parhasard.net>
date Thu, 31 Dec 2009 15:09:41 +0000
parents 5d1743698fb3
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 ;;; mwheel.el --- Mouse support for MS intelli-mouse type mice
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 ;; Copyright (C) 1998, Free Software Foundation, Inc.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 ;; Maintainer: William M. Perry <wmperry@cs.indiana.edu>
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 ;; Keywords: mouse
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 ;; This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 ;; XEmacs is free software; you can redistribute it and/or modify it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 ;; under the terms of the GNU General Public License as published by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 ;; any later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 ;; XEmacs is distributed in the hope that it will be useful, but
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 ;; General Public License for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
20 ;; along with XEmacs; see the file COPYING. If not, write to the
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 ;; Boston, MA 02111-1307, USA.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 ;;; Synched up with: Not synched.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 ;;; Commentary:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 ;; This code will enable the use of the infamous 'wheel' on the new
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 ;; crop of mice. Under XFree86 and the XSuSE X Servers, the wheel
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 ;; events are sent as button4/button5 events.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 ;; I for one would prefer some way of converting the button4/button5
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 ;; events into different event types, like 'mwheel-up' or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 ;; 'mwheel-down', but I cannot find a way to do this very easily (or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 ;; portably), so for now I just live with it.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 ;; To enable this code, simply put this at the top of your .emacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 ;; file:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 ;;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 ;; (autoload 'mwheel-install "mwheel" "Enable mouse wheel support.")
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 ;; (mwheel-install)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 ;;; Code:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 (require 'custom)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 (require 'cl)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47
502
7039e6323819 [xemacs-hg @ 2001-05-04 22:41:46 by ben]
ben
parents: 458
diff changeset
48 (globally-declare-fboundp
7039e6323819 [xemacs-hg @ 2001-05-04 22:41:46 by ben]
ben
parents: 458
diff changeset
49 '(event-basic-type
7039e6323819 [xemacs-hg @ 2001-05-04 22:41:46 by ben]
ben
parents: 458
diff changeset
50 posn-window event-start mwheel-event-window mwheel-event-button))
7039e6323819 [xemacs-hg @ 2001-05-04 22:41:46 by ben]
ben
parents: 458
diff changeset
51
1621
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
52 (defcustom mwheel-scroll-amount '(5 1 nil)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 "Amount to scroll windows by when spinning the mouse wheel.
1621
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
54 A list with 3 elements specifying the amount to scroll on: a normal wheel
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
55 event, a wheel event with the shift key pressed, and a wheel event with the
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
56 control key pressed, in that order.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 Each item should be the number of lines to scroll, or `nil' for near
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 full screen.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 A near full screen is `next-screen-context-lines' less than a full screen."
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 :group 'mouse
1621
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
62 :type '(list
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 (choice :tag "Normal"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 (const :tag "Full screen" :value nil)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 (integer :tag "Specific # of lines"))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 (choice :tag "Shifted"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 (const :tag "Full screen" :value nil)
1621
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
68 (integer :tag "Specific # of lines"))
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
69 (choice :tag "Controlled"
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
70 (const :tag "Full screen" :value nil)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 (integer :tag "Specific # of lines"))))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 (defcustom mwheel-follow-mouse nil
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 "Whether the mouse wheel should scroll the window that the mouse is over.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 This can be slightly disconcerting, but some people may prefer it."
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 :group 'mouse
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 :type 'boolean)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 (if (not (fboundp 'event-button))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 (defun mwheel-event-button (event)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 (let ((x (symbol-name (event-basic-type event))))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 (if (not (string-match "^mouse-\\([0-9]+\\)" x))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 (error "Not a button event: %S" event))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 (string-to-int (substring x (match-beginning 1) (match-end 1)))))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 (fset 'mwheel-event-button 'event-button))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 (if (not (fboundp 'event-window))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 (defun mwheel-event-window (event)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 (posn-window (event-start event)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 (fset 'mwheel-event-window 'event-window))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 (defun mwheel-scroll (event)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 (interactive "e")
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 (let ((curwin (if mwheel-follow-mouse
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 (prog1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 (selected-window)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 (select-window (mwheel-event-window event)))))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 (amt (if (memq 'shift (event-modifiers event))
1621
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
99 (cadr mwheel-scroll-amount)
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
100 (if (memq 'control (event-modifiers event))
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
101 (caddr mwheel-scroll-amount)
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
102 (car mwheel-scroll-amount)))))
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
103 (unwind-protect
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
104 (case (mwheel-event-button event)
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
105 (4 (scroll-down amt))
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
106 (5 (scroll-up amt))
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
107 (otherwise (error "Bad binding in mwheel-scroll")))
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
108 (if curwin (select-window curwin)))
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
109 ))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 ;;;###autoload
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 (defun mwheel-install ()
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 "Enable mouse wheel support."
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 428
diff changeset
114 (interactive)
1621
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
115 (let ((keys '([(mouse-4)] [(shift mouse-4)] [(control mouse-4)]
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
116 [(mouse-5)] [(shift mouse-5)] [(control mouse-5)])))
9cf129cb99b9 [xemacs-hg @ 2003-08-13 11:22:42 by stephent]
stephent
parents: 502
diff changeset
117
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 ;; This condition-case is here because Emacs 19 will throw an error
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 ;; if you try to define a key that it does not know about. I for one
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 ;; prefer to just unconditionally do a mwheel-install in my .emacs, so
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 ;; that if the wheeled-mouse is there, it just works, and this way it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 ;; doesn't yell at me if I'm on my laptop or another machine, etc.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 (condition-case ()
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 (while keys
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 (define-key global-map (car keys) 'mwheel-scroll)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 (setq keys (cdr keys)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 (error nil))))
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 444
diff changeset
128
2546
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
129 ;;;###autoload
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
130 (define-behavior 'mwheel
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
131 "This code enables the use of the infamous 'wheel' on the new
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
132 crop of mice. Under XFree86 and the XSuSE X Servers, the wheel
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
133 events are sent as button4/button5 events, which are automatically
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
134 set up to do scrolling in the expected way. The actual way that the
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
135 scrolling works can be controlled by `mwheel-scroll-amount' and
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
136 `mwheel-follow-mouse'."
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
137 :group 'mouse
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
138 :short-doc "Mouse wheel support for X Windows"
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
139 :enable 'mwheel-install)
5d1743698fb3 [xemacs-hg @ 2005-02-03 05:26:39 by ben]
ben
parents: 1621
diff changeset
140
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 (provide 'mwheel)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 ;;; mwheel.el ends here