naming of 26.1 mwheel- user options

naming of 26.1 mwheel- user options

[Glenn Morris]

Trivia:

For consistency with previous usage, shouldn't the new-in-26.1 mwheel-*
user options in mwheel.el be called "mouse-wheel-"?
(mwheel-tilt-scroll-p etc.)

Re: naming of 26.1 mwheel- user options

[Tak Kunihiro]

> For consistency with previous usage, shouldn't the new-in-26.1
> mwheel-* user options in mwheel.el be called "mouse-wheel-"?
> (mwheel-tilt-scroll-p etc.)

I think so too.  I also leaned that to use `-p' at the end of variable
is not recommended.

`mwheel-wheel-tilt-scroll' instead of `mwheel-tilt-scroll-p'?

Re: naming of 26.1 mwheel- user options

[Stefan Monnier]

> `mwheel-wheel-tilt-scroll' instead of `mwheel-tilt-scroll-p'?

Yes, please,


        Stefan

Re: naming of 26.1 mwheel- user options

[Tak Kunihiro]

[-- Attachment #1: Type: text/plain, Size: 616 bytes --]

I’m sending a patch to change names
from mwheel-tilt-scroll-p and mwheel-flip-direction
to   mwheel-wheel-tilt-scroll and mwheel-wheel-flip-direction.

* Commit log

    Change name of variables to be consistent

    Variables mwheel-tilt-scroll-p and mwheel-flip-direction were
    renamed to mwheel-wheel-tilt-scroll and
    mwheel-wheel-flip-direction.  Suggested by Glenn Morris
    <rgm@gnu.org> in emacs-devel@gnu.org.

    * lisp/mwheel.el (mwheel-wheel-tilt-scroll):
    (mwheel-wheel-flip-direction):
    * etc/NEWS:
    * doc/emacs/frames.texi (Mouse Commands): Variables are renamed.



[-- Attachment #2: mwheel.el.diff --]
[-- Type: application/octet-stream, Size: 1601 bytes --]

diff --git a/lisp/mwheel.el b/lisp/mwheel.el
index 9718ab8..cba1724 100644
--- a/lisp/mwheel.el
+++ b/lisp/mwheel.el
@@ -255,13 +255,13 @@ mwheel-scroll
                    ;; Make sure we do indeed scroll to the end of the buffer.
                    (end-of-buffer (while t (funcall mwheel-scroll-up-function)))))
                 ((eq button mouse-wheel-left-event) ; for tilt scroll
-                 (when mwheel-tilt-scroll-p
-                   (funcall (if mwheel-flip-direction
+                 (when mwheel-wheel-tilt-scroll
+                   (funcall (if mwheel-wheel-flip-direction
                                 mwheel-scroll-right-function
                               mwheel-scroll-left-function) amt)))
                 ((eq button mouse-wheel-right-event) ; for tilt scroll
-                 (when mwheel-tilt-scroll-p
-                   (funcall (if mwheel-flip-direction
+                 (when mwheel-wheel-tilt-scroll
+                   (funcall (if mwheel-wheel-flip-direction
                                 mwheel-scroll-left-function
                               mwheel-scroll-right-function) amt)))
 		(t (error "Bad binding in mwheel-scroll"))))
@@ -324,13 +324,13 @@ mwheel-install
 
 ;;; For tilt-scroll
 ;;;
-(defcustom mwheel-tilt-scroll-p nil
+(defcustom mwheel-wheel-tilt-scroll nil
   "Enable scroll using tilting mouse wheel."
   :group 'mouse
   :type 'boolean
   :version "26.1")
 
-(defcustom mwheel-flip-direction nil
+(defcustom mwheel-wheel-flip-direction nil
   "Swap direction of 'wheel-right and 'wheel-left."
   :group 'mouse
   :type 'boolean

[-- Attachment #3: frames.texi.diff --]
[-- Type: application/octet-stream, Size: 979 bytes --]

diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 8cc4d64..c07e471 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -207,13 +207,13 @@ Mouse Commands
 @code{mouse-wheel-progressive-speed} determines whether the scroll
 speed is linked to how fast you move the wheel.
 
-@vindex mwheel-tilt-scroll-p
-@vindex mwheel-flip-direction
+@vindex mwheel-wheel-tilt-scroll
+@vindex mwheel-wheel-flip-direction
 Emacs can also support horizontal scrolling if your mouse's wheel can
 be tilted.  This feature is off by default; the variable
-@code{mwheel-tilt-scroll-p} turns it on.  If you'd like to reverse the
-direction of horizontal scrolling, customize the variable
-@code{mwheel-flip-direction} to a non-@code{nil} value.
+@code{mwheel-wheel-tilt-scroll} turns it on.  If you'd like to reverse
+the direction of horizontal scrolling, customize the variable
+@code{mwheel-wheel-flip-direction} to a non-@code{nil} value.
 
 
 @node Word and Line Mouse

[-- Attachment #4: NEWS.diff --]
[-- Type: application/octet-stream, Size: 571 bytes --]

diff --git a/etc/NEWS b/etc/NEWS
index cb4048d..abd0792 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -431,9 +431,9 @@ always restricting the margin to a quarter of the window.
 
 +++
 ** Emacs can scroll horizontally using mouse, touchpad, and trackbar.
-You can enable this by customizing 'mwheel-tilt-scroll-p'.  If you
+You can enable this by customizing 'mwheel-wheel-tilt-scroll'.  If you
 want to reverse the direction of the scroll, customize
-'mwheel-flip-direction'.
+'mwheel-wheel-flip-direction'.
 
 +++
 ** The default GnuTLS priority string now includes %DUMBFW.

[-- Attachment #5: Type: text/plain, Size: 2 bytes --]

Re: naming of 26.1 mwheel- user options

[Alan Third]

[-- Attachment #1: Type: text/plain, Size: 740 bytes --]

Mwheel-wheel? Shouldn't it be mouse-wheel?

On 28 Feb 2018 8:29 a.m., "Tak Kunihiro" <tkk@misasa.okayama-u.ac.jp> wrote:

I’m sending a patch to change names
from mwheel-tilt-scroll-p and mwheel-flip-direction
to   mwheel-wheel-tilt-scroll and mwheel-wheel-flip-direction.

* Commit log

    Change name of variables to be consistent

    Variables mwheel-tilt-scroll-p and mwheel-flip-direction were
    renamed to mwheel-wheel-tilt-scroll and
    mwheel-wheel-flip-direction.  Suggested by Glenn Morris
    <rgm@gnu.org> in emacs-devel@gnu.org.

    * lisp/mwheel.el (mwheel-wheel-tilt-scroll):
    (mwheel-wheel-flip-direction):
    * etc/NEWS:
    * doc/emacs/frames.texi (Mouse Commands): Variables are renamed.

[-- Attachment #2: Type: text/html, Size: 1242 bytes --]

Re: naming of 26.1 mwheel- user options

[Tak Kunihiro]

[-- Attachment #1: Type: Text/Plain, Size: 707 bytes --]

> Mwheel-wheel? Shouldn't it be mouse-wheel?

Thank you to point out!  Let me send a patch again, to change names as
below.

[from mwheel-tilt-scroll-p]  --> [to mouse-wheel-tilt-scroll]
[from mwheel-flip-direction] --> [to mouse-wheel-flip-direction]

* Commit log

    Change name of variables to be consistent

    Variables mwheel-tilt-scroll-p and mwheel-flip-direction were
    renamed to mouse-wheel-tilt-scroll and mouse-wheel-flip-direction,
    respectively.  Suggested by Glenn Morris <rgm@gnu.org> in
    emacs-devel@gnu.org.

    * lisp/mwheel.el (mouse-wheel-tilt-scroll):
    (mouse-wheel-flip-direction):
    * etc/NEWS:
    * doc/emacs/frames.texi (Mouse Commands): Variables are renamed.


[-- Attachment #2: frames.texi.diff --]
[-- Type: Text/X-Patch, Size: 975 bytes --]

diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 8cc4d64..c07e471 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -207,13 +207,13 @@ Mouse Commands
 @code{mouse-wheel-progressive-speed} determines whether the scroll
 speed is linked to how fast you move the wheel.
 
-@vindex mwheel-tilt-scroll-p
-@vindex mwheel-flip-direction
+@vindex mouse-wheel-tilt-scroll
+@vindex mouse-wheel-flip-direction
 Emacs can also support horizontal scrolling if your mouse's wheel can
 be tilted.  This feature is off by default; the variable
-@code{mwheel-tilt-scroll-p} turns it on.  If you'd like to reverse the
-direction of horizontal scrolling, customize the variable
-@code{mwheel-flip-direction} to a non-@code{nil} value.
+@code{mouse-wheel-tilt-scroll} turns it on.  If you'd like to reverse
+the direction of horizontal scrolling, customize the variable
+@code{mouse-wheel-flip-direction} to a non-@code{nil} value.
 
 
 @node Word and Line Mouse

[-- Attachment #3: mwheel.el.diff --]
[-- Type: Text/X-Patch, Size: 1595 bytes --]

diff --git a/lisp/mwheel.el b/lisp/mwheel.el
index 9718ab8..cba1724 100644
--- a/lisp/mwheel.el
+++ b/lisp/mwheel.el
@@ -255,13 +255,13 @@ mwheel-scroll
                    ;; Make sure we do indeed scroll to the end of the buffer.
                    (end-of-buffer (while t (funcall mwheel-scroll-up-function)))))
                 ((eq button mouse-wheel-left-event) ; for tilt scroll
-                 (when mwheel-tilt-scroll-p
-                   (funcall (if mwheel-flip-direction
+                 (when mouse-wheel-tilt-scroll
+                   (funcall (if mouse-wheel-flip-direction
                                 mwheel-scroll-right-function
                               mwheel-scroll-left-function) amt)))
                 ((eq button mouse-wheel-right-event) ; for tilt scroll
-                 (when mwheel-tilt-scroll-p
-                   (funcall (if mwheel-flip-direction
+                 (when mouse-wheel-tilt-scroll
+                   (funcall (if mouse-wheel-flip-direction
                                 mwheel-scroll-left-function
                               mwheel-scroll-right-function) amt)))
 		(t (error "Bad binding in mwheel-scroll"))))
@@ -324,13 +324,13 @@ mwheel-install
 
 ;;; For tilt-scroll
 ;;;
-(defcustom mwheel-tilt-scroll-p nil
+(defcustom mouse-wheel-tilt-scroll nil
   "Enable scroll using tilting mouse wheel."
   :group 'mouse
   :type 'boolean
   :version "26.1")
 
-(defcustom mwheel-flip-direction nil
+(defcustom mouse-wheel-flip-direction nil
   "Swap direction of 'wheel-right and 'wheel-left."
   :group 'mouse
   :type 'boolean

[-- Attachment #4: NEWS.diff --]
[-- Type: Text/X-Patch, Size: 569 bytes --]

diff --git a/etc/NEWS b/etc/NEWS
index cb4048d..abd0792 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -431,9 +431,9 @@ always restricting the margin to a quarter of the window.
 
 +++
 ** Emacs can scroll horizontally using mouse, touchpad, and trackbar.
-You can enable this by customizing 'mwheel-tilt-scroll-p'.  If you
+You can enable this by customizing 'mouse-wheel-tilt-scroll'.  If you
 want to reverse the direction of the scroll, customize
-'mwheel-flip-direction'.
+'mouse-wheel-flip-direction'.
 
 +++
 ** The default GnuTLS priority string now includes %DUMBFW.

Re: naming of 26.1 mwheel- user options

[Glenn Morris]

Thanks.
I also wonder, why are mwheel-scroll-left-function and
mwheel-scroll-right-function user options, when the pre-existing
mwheel-scroll-up-function and mwheel-scroll-down-function aren't?

Re: naming of 26.1 mwheel- user options

[Tak Kunihiro]

> I also wonder, why are mwheel-scroll-left-function and
> mwheel-scroll-right-function user options, when the pre-existing
> mwheel-scroll-up-function and mwheel-scroll-down-function aren't?

I think I was not carefull enough.
I have no argument to change those two from defcustom to defvar.

From
(defcustom mwheel-scroll-left-function 'scroll-left)
(defcustom mwheel-scroll-right-function 'scroll-right)

To
(defvar mwheel-scroll-left-function 'scroll-left)
(defvar mwheel-scroll-right-function 'scroll-right)

Re: naming of 26.1 mwheel- user options

[Tak Kunihiro]

[-- Attachment #1: Type: text/plain, Size: 1180 bytes --]

Let me send a patch again, to change names of two variables and
how two variables are defined, as below.

[from mwheel-tilt-scroll-p]  --> [to mouse-wheel-tilt-scroll]
[from mwheel-flip-direction] --> [to mouse-wheel-flip-direction]
[from (defcustom mwheel-scroll-left-function 'scroll-left)]
   --> [to (defvar mwheel-scroll-left-function 'scroll-left)]
[from (defcustom mwheel-scroll-right-function 'scroll-right)]
   --> [to (defvar mwheel-scroll-right-function 'scroll-right)]


* Commit log

   Change name and definition of variables to be consistent

   Variables mwheel-tilt-scroll-p and mwheel-flip-direction were
   renamed to mouse-wheel-tilt-scroll and mouse-wheel-flip-direction,
   respectively.  Variables mwheel-scroll-left-function and
   mwheel-scroll-right-function that were defined by defcustom are
   defined by defvar.  Suggested by Glenn Morris <rgm@gnu.org> in
   emacs-devel@gnu.org.

   * etc/NEWS:
   * doc/emacs/frames.texi (Mouse Commands):
   * lisp/mwheel.el (mouse-wheel-tilt-scroll):
   (mouse-wheel-flip-direction): Variables are renamed.
   * lisp/mwheel.el (mwheel-scroll-left-function):
   (mwheel-scroll-right-function): Defined as defvar.


[-- Attachment #2: frames.texi.diff --]
[-- Type: application/octet-stream, Size: 975 bytes --]

diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 8cc4d64..c07e471 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -207,13 +207,13 @@ Mouse Commands
 @code{mouse-wheel-progressive-speed} determines whether the scroll
 speed is linked to how fast you move the wheel.
 
-@vindex mwheel-tilt-scroll-p
-@vindex mwheel-flip-direction
+@vindex mouse-wheel-tilt-scroll
+@vindex mouse-wheel-flip-direction
 Emacs can also support horizontal scrolling if your mouse's wheel can
 be tilted.  This feature is off by default; the variable
-@code{mwheel-tilt-scroll-p} turns it on.  If you'd like to reverse the
-direction of horizontal scrolling, customize the variable
-@code{mwheel-flip-direction} to a non-@code{nil} value.
+@code{mouse-wheel-tilt-scroll} turns it on.  If you'd like to reverse
+the direction of horizontal scrolling, customize the variable
+@code{mouse-wheel-flip-direction} to a non-@code{nil} value.
 
 
 @node Word and Line Mouse

[-- Attachment #3: mwheel.el.diff --]
[-- Type: application/octet-stream, Size: 2234 bytes --]

diff --git a/lisp/mwheel.el b/lisp/mwheel.el
index 9718ab8..2e749a9 100644
--- a/lisp/mwheel.el
+++ b/lisp/mwheel.el
@@ -255,13 +255,13 @@ mwheel-scroll
                    ;; Make sure we do indeed scroll to the end of the buffer.
                    (end-of-buffer (while t (funcall mwheel-scroll-up-function)))))
                 ((eq button mouse-wheel-left-event) ; for tilt scroll
-                 (when mwheel-tilt-scroll-p
-                   (funcall (if mwheel-flip-direction
+                 (when mouse-wheel-tilt-scroll
+                   (funcall (if mouse-wheel-flip-direction
                                 mwheel-scroll-right-function
                               mwheel-scroll-left-function) amt)))
                 ((eq button mouse-wheel-right-event) ; for tilt scroll
-                 (when mwheel-tilt-scroll-p
-                   (funcall (if mwheel-flip-direction
+                 (when mouse-wheel-tilt-scroll
+                   (funcall (if mouse-wheel-flip-direction
                                 mwheel-scroll-left-function
                               mwheel-scroll-right-function) amt)))
 		(t (error "Bad binding in mwheel-scroll"))))
@@ -324,29 +324,23 @@ mwheel-install
 
 ;;; For tilt-scroll
 ;;;
-(defcustom mwheel-tilt-scroll-p nil
+(defcustom mouse-wheel-tilt-scroll nil
   "Enable scroll using tilting mouse wheel."
   :group 'mouse
   :type 'boolean
   :version "26.1")
 
-(defcustom mwheel-flip-direction nil
+(defcustom mouse-wheel-flip-direction nil
   "Swap direction of 'wheel-right and 'wheel-left."
   :group 'mouse
   :type 'boolean
   :version "26.1")
 
-(defcustom mwheel-scroll-left-function 'scroll-left
-  "Function that does the job of scrolling left."
-  :group 'mouse
-  :type 'function
-  :version "26.1")
+(defvar mwheel-scroll-left-function 'scroll-left
+  "Function that does the job of scrolling left.")
 
-(defcustom mwheel-scroll-right-function 'scroll-right
-  "Function that does the job of scrolling right."
-  :group 'mouse
-  :type 'function
-  :version "26.1")
+(defvar mwheel-scroll-right-function 'scroll-right
+  "Function that does the job of scrolling right.")
 
 (defvar mouse-wheel-left-event
   (if (or (featurep 'w32-win) (featurep 'ns-win))

[-- Attachment #4: NEWS.diff --]
[-- Type: application/octet-stream, Size: 569 bytes --]

diff --git a/etc/NEWS b/etc/NEWS
index cb4048d..abd0792 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -431,9 +431,9 @@ always restricting the margin to a quarter of the window.
 
 +++
 ** Emacs can scroll horizontally using mouse, touchpad, and trackbar.
-You can enable this by customizing 'mwheel-tilt-scroll-p'.  If you
+You can enable this by customizing 'mouse-wheel-tilt-scroll'.  If you
 want to reverse the direction of the scroll, customize
-'mwheel-flip-direction'.
+'mouse-wheel-flip-direction'.
 
 +++
 ** The default GnuTLS priority string now includes %DUMBFW.