From 59dfcbfc39b761de2b2af26da7f1198cf1db5752 Mon Sep 17 00:00:00 2001
From: Rico Tiongson <thericotiongson@gmail.com>
Date: Sat, 18 Apr 2020 03:26:01 +0800
Subject: [PATCH] Add comments on experimental scrolling

---
 README.md                                     |  6 ++
 .../gesture/mouse_hold_gesture.cpp            | 55 +++++++++++++++----
 defaults.conf                                 | 11 +++-
 3 files changed, 58 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index ad69e9e..da6680a 100644
--- a/README.md
+++ b/README.md
@@ -109,6 +109,8 @@ We have included simple mouse gestures on swipe by setting `hold3` and `hold4`.
 * button3 - right click
 * button4 - wheel up (experimental)
 * button5 - wheel down (experimental)
+* scroll - natural scrolling (experimental)
+* scroll_reverse - reverse scrolling (experimental)
 
 ## Example Configuration
 
@@ -136,6 +138,10 @@ right4 = ctrl+alt+shift+Left
 
 # three-finger middle click (experimental)
 # hold3 = button2
+
+# three-finger scroll (experimental)
+# hold3 = scroll
+# hold3 = scroll_reverse
 ```
 
 
diff --git a/comfortable_swipe/gesture/mouse_hold_gesture.cpp b/comfortable_swipe/gesture/mouse_hold_gesture.cpp
index c6fd11b..dbed473 100644
--- a/comfortable_swipe/gesture/mouse_hold_gesture.cpp
+++ b/comfortable_swipe/gesture/mouse_hold_gesture.cpp
@@ -33,6 +33,18 @@ extern "C"
 
 namespace comfortable_swipe::gesture
 {
+    enum {
+        MOUSE_NONE = -1,
+        MOUSE_MOVE = 0,
+        MOUSE_LEFT_CLICK = 1,
+        MOUSE_MIDDLE_CLICK = 2,
+        MOUSE_RIGHT_CLICK = 3,
+        MOUSE_WHEEL_UP = 4,
+        MOUSE_WHEEL_DOWN = 5,
+        MOUSE_SCROLL = 6,
+        MOUSE_SCROLL_REVERSE = 7
+    };
+
     /**
      * Constructs a new mouse gesture, given "hold3" and "hold4" configurations.
      */
@@ -42,7 +54,7 @@ namespace comfortable_swipe::gesture
         const char* hold4
     ):
         comfortable_swipe::gesture::swipe_gesture(),
-        button(-1),
+        button(MOUSE_NONE),
         hold3(hold3),
         hold4(hold4),
         flag_mousedown(false)
@@ -60,11 +72,11 @@ namespace comfortable_swipe::gesture
     void mouse_hold_gesture::do_mousedown(const char * mouseinput)
     {
         const int button = this->button = this->parse_mouse_button(mouseinput);
-        if (button != -1)
+        if (button != MOUSE_NONE)
         {
             // eg. MOUSE DOWN hold3 mouse1
             std::printf("MOUSE DOWN hold%d %s\n", this->fingers, mouseinput);
-            if (1 <= button && button <= 3)
+            if (MOUSE_LEFT_CLICK <= button && button <= MOUSE_RIGHT_CLICK)
             {
                 // send mouse down on associated button
                 xdo_mouse_down(this->xdo, CURRENTWINDOW, button);
@@ -79,10 +91,10 @@ namespace comfortable_swipe::gesture
     void mouse_hold_gesture::do_mouseup(const char * mouseinput)
     {
         const int button = this->button = this->parse_mouse_button(mouseinput);
-        if (button != -1)
+        if (button != MOUSE_NONE)
         {
             std::printf("MOUSE UP hold%d %s\n", this->fingers, mouseinput);
-            if (1 <= button && button <= 5)
+            if (MOUSE_LEFT_CLICK <= button && button <= MOUSE_RIGHT_CLICK)
             {
                 // send mouse up on associated button
                 xdo_mouse_up(this->xdo, CURRENTWINDOW, button);
@@ -99,16 +111,25 @@ namespace comfortable_swipe::gesture
     {
         // just move without holding button down
         if (std::strcmp(input, "move") == 0)
-            return 0;
+            return MOUSE_MOVE;
+
+        if (std::strcmp(input, "scroll") == 0)
+            return MOUSE_SCROLL;
+
+        if (std::strcmp(input, "scroll_reverse") == 0)
+            return MOUSE_SCROLL_REVERSE;
+
         // get button number
         int button;
         if (std::sscanf(input, "button%d", &button) == 1)
         {
-            // parse the number after "mouse"
-            return button;
+            if (1 <= button && button <= 6)
+            {
+                return button;
+            }
         }
 
-        return -1;
+        return MOUSE_NONE;
     }
 
     /**
@@ -147,10 +168,22 @@ namespace comfortable_swipe::gesture
                     this->udy
                 );
             }
-            else if (4 <= this->button && this->button <= 5)
+            else if (this->button == MOUSE_SCROLL || this->button == MOUSE_SCROLL_REVERSE)
             {
-                // perform wheel during update
+                // perform naive scroll depending on vertical direction
+                int wheel = MOUSE_WHEEL_DOWN;
+                if ((this->udy > 0) == (this->button == MOUSE_SCROLL))
+                    wheel = MOUSE_WHEEL_UP;
+
+                // click wheel on update (note: this is not precise)
+                xdo_mouse_down(this->xdo, CURRENTWINDOW, wheel);
+                xdo_mouse_up(this->xdo, CURRENTWINDOW, wheel);
+            }
+            else if (this->button == MOUSE_WHEEL_UP || this->button == MOUSE_WHEEL_DOWN)
+            {
+                // click wheel button on 4 or 5
                 xdo_mouse_down(this->xdo, CURRENTWINDOW, this->button);
+                xdo_mouse_up(this->xdo, CURRENTWINDOW, this->button);
             }
         }
 
diff --git a/defaults.conf b/defaults.conf
index 3df55d4..8cdb545 100644
--- a/defaults.conf
+++ b/defaults.conf
@@ -67,9 +67,14 @@ threshold = 0.0
 
 # (1: left click, 2: middle click, 3: right click, 4: wheel up, 5: wheel down)
 
-# Uncomment to hold a mouse button on 3/4 fingers
+# You can set mouse buttons to hold
 # hold3 = button1
-# hold4 = button1
+# hold3 = button2
+# hold3 = button3
 
-# You can also set to just "move" the mouse
+# Or you can just let the mouse move with the cursor
 # hold3 = move
+
+# Use wheel scroll (experimental)
+# hold4 = scroll
+# hold4 = scroll_reverse