Skip to content

Add: add toogle error check and MultiClikck, optimize the code and api #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vcaesar merged 4 commits into from
Jan 18, 2026
Merged

Add: add toogle error check and MultiClikck, optimize the code and api #757

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c439be
Add: add toogle error check and MultiClikck, optimize the code and api
vcaesar Jan 18, 2026
59e4b30
Add: add mac special click support
vcaesar Jan 18, 2026
96fac4f
Update: optimize the code and fixed args
vcaesar Jan 18, 2026
dc03345
Fix: fixed the button string
vcaesar Jan 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 13 additions & 36 deletions mouse/mouse_c.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
}

#elif defined(IS_WINDOWS)

DWORD MMMouseUpToMEventF(MMMouseButton button) {
if (button == LEFT_BUTTON) { return MOUSEEVENTF_LEFTUP; }
if (button == RIGHT_BUTTON) { return MOUSEEVENTF_RIGHTUP; }
Expand Down Expand Up @@ -99,7 +98,6 @@ void moveMouse(MMPointInt32 point){
CGPointFromMMPointInt32(point), kCGMouseButtonLeft);

calculateDeltas(&move, point);

CGEventPost(kCGHIDEventTap, move);
CFRelease(move);
CFRelease(source);
Expand Down Expand Up @@ -156,7 +154,7 @@ MMPointInt32 location() {
}

/* Press down a button, or release it. */
int toggleMouseErr(bool down, MMMouseButton button) {
int toggleMouse(bool down, MMMouseButton button) {
#if defined(IS_MACOSX)
const CGPoint currentPos = CGPointFromMMPointInt32(location());
const CGEventType mouseType = MMMouseToCGEventType(down, button);
Expand All @@ -167,20 +165,17 @@ int toggleMouseErr(bool down, MMMouseButton button) {
CFRelease(source);
return (int)kCGErrorCannotComplete;
}

CGEventPost(kCGHIDEventTap, event);
CFRelease(event);
CFRelease(source);

return 0;
#elif defined(USE_X11)
Display *display = XGetMainDisplay();
Status status = XTestFakeButtonEvent(display, button, down ? True : False, CurrentTime);
XSync(display, false);

return status ? 0 : 1;
#elif defined(IS_WINDOWS)
// mouse_event(MMMouseToMEventF(down, button), 0, 0, 0, 0);
INPUT mouseInput;

mouseInput.type = INPUT_MOUSE;
Expand All @@ -195,26 +190,18 @@ int toggleMouseErr(bool down, MMMouseButton button) {
#endif
}

void toggleMouse(bool down, MMMouseButton button) {
toggleMouseErr(down, button);
}

int clickMouseErr(MMMouseButton button){
int err = toggleMouseErr(true, button);
int clickMouse(MMMouseButton button){
int err = toggleMouse(true, button);
if (err != 0) {
return err;
}

microsleep(5.0);

return toggleMouseErr(false, button);
}

void clickMouse(MMMouseButton button){
clickMouseErr(button);
return toggleMouse(false, button);
}

int doubleClickErr(MMMouseButton button){
/* Special function for sending double clicks, needed for MacOS. */
int doubleClick(MMMouseButton button){
#if defined(IS_MACOSX)
/* Double click for Mac. */
const CGPoint currentPos = CGPointFromMMPointInt32(location());
Expand All @@ -223,7 +210,6 @@ int doubleClickErr(MMMouseButton button){

CGEventSourceRef source = CGEventSourceCreate(kCGEventSourceStateHIDSystemState);
CGEventRef event = CGEventCreateMouseEvent(source, mouseTypeDown, currentPos, kCGMouseButtonLeft);

if (event == NULL) {
CFRelease(source);
return (int)kCGErrorCannotComplete;
Expand All @@ -238,26 +224,18 @@ int doubleClickErr(MMMouseButton button){

CFRelease(event);
CFRelease(source);

return 0;
#else
/* Double click for everything else. */
int err = clickMouseErr(button);
int err = clickMouse(button);
if (err != 0) {
return err;
}

microsleep(200);

return clickMouseErr(button);
return clickMouse(button);
#endif
}

/* Special function for sending double clicks, needed for MacOS. */
void doubleClick(MMMouseButton button){
doubleClickErr(button);
}

/* Function used to scroll the screen in the required direction. */
void scrollMouseXY(int x, int y) {
#if defined(IS_WINDOWS)
Expand All @@ -268,7 +246,7 @@ void scrollMouseXY(int x, int y) {

#if defined(IS_MACOSX)
CGEventSourceRef source = CGEventSourceCreate(kCGEventSourceStateHIDSystemState);
CGEventRef event = CGEventCreateScrollWheelEvent(source, kCGScrollEventUnitPixel, 2, y, x);
CGEventRef event = CGEventCreateScrollWheelEvent(source, kCGScrollEventUnitPixel, 2, y, x);
CGEventPost(kCGHIDEventTap, event);

CFRelease(event);
Expand Down Expand Up @@ -351,10 +329,10 @@ bool smoothlyMoveMouse(MMPointInt32 endPoint, double lowSpeed, double highSpeed)
velo_y /= veloDistance;

pos.x += floor(velo_x + 0.5);
pos.y += floor(velo_y + 0.5);
pos.y += floor(velo_y + 0.5);

/* Make sure we are in the screen boundaries! (Strange things will happen if we are not.) */
// if (pos.x >= screenSize.w || pos.y >= screenSize.h) {
/* Make sure we are in the screen boundaries! */
// if (pos.x >= screenSize.w || pos.y >= screenSize.h) {
// return false;
// }
moveMouse(pos);
Expand All @@ -363,6 +341,5 @@ bool smoothlyMoveMouse(MMPointInt32 endPoint, double lowSpeed, double highSpeed)
microsleep(DEADBEEF_UNIFORM(lowSpeed, highSpeed));
// microsleep(DEADBEEF_UNIFORM(1.0, 3.0));
}

return true;
}
67 changes: 43 additions & 24 deletions robotgo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ func Location() (int, int) {
return x, y
}

// Click click the mouse button
// ClickV1 click the mouse button
//
// robotgo.Click(button string, double bool)
//
Expand All @@ -668,7 +668,7 @@ func Location() (int, int) {
// robotgo.Click() // default is left button
// robotgo.Click("right")
// robotgo.Click("wheelLeft")
func Click(args ...interface{}) {
func ClickV1(args ...interface{}) {
var (
button C.MMMouseButton = C.LEFT_BUTTON
double bool
Expand All @@ -691,18 +691,19 @@ func Click(args ...interface{}) {
MilliSleep(MouseSleep)
}

// ClickE click the mouse button and return error
// Click click the mouse button and return error
//
// robotgo.ClickE(button string, double bool)
// robotgo.Click(button string, double bool)
//
// Examples:
//
// err := robotgo.ClickE() // default is left button
// err := robotgo.ClickE("right")
func ClickE(args ...interface{}) error {
// err := robotgo.Click() // default is left button
// err := robotgo.Click("right")
func Click(args ...interface{}) error {
Comment on lines +694 to +702
Copy link

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Click function signature in the documentation comment still references the old API with (button string, double bool), but the actual implementation now supports an additional count parameter at args[3]. The documentation should be updated to reflect the new signature or the count parameter implementation should be reconsidered since it appears incomplete.

Copilot uses AI. Check for mistakes.
var (
button C.MMMouseButton = C.LEFT_BUTTON
double bool
count int
)

if len(args) > 0 {
Expand All @@ -720,30 +721,46 @@ func ClickE(args ...interface{}) error {
}
double = dbl
}
if len(args) > 3 {
count = args[3].(int)
}

defer MilliSleep(MouseSleep)

if !double {
if code := C.toggleMouseErr(true, button); code != 0 {
return formatClickError(int(code), button, "down", false)
if code := C.toggleMouse(true, button); code != 0 {
return formatClickError(int(code), button, "down", count)
}

// match clickMouse timing
C.microsleep(C.double(5.0))

if code := C.toggleMouseErr(false, button); code != 0 {
return formatClickError(int(code), button, "up", false)
MilliSleep(5)
if code := C.toggleMouse(false, button); code != 0 {
return formatClickError(int(code), button, "up", count)
}
} else {
if code := C.doubleClickErr(button); code != 0 {
return formatClickError(int(code), button, "double", true)
if code := C.doubleClick(button); code != 0 {
return formatClickError(int(code), button, "double", 2)
}
}
return nil
}

// MultiClick performs multiple clicks and returns error
//
// robotgo.MultiClick(button string, count int)
func MultiClick(button string, count int) error {
if count < 1 {
return nil
}
btn := CheckMouse(button)
defer MilliSleep(MouseSleep)

for i := 0; i < count; i++ {
if err := Click(btn, false, count); err != nil {
Copy link

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MultiClick function passes the total count value as the third argument to Click, but this is incorrect. The Click function's signature is Click(button string, double bool, ...), so the third argument would be interpreted as something else (and based on line 724-726, it's trying to access args[3] for count). This will result in incorrect behavior. The count parameter in Click appears to be meant for error reporting only, not as a loop counter. Remove the count parameter from this Click call.

Suggested change
if err := Click(btn, false, count); err != nil {
if err := Click(btn, false); err != nil {

Copilot uses AI. Check for mistakes.
return err
}
}
return nil
}

func formatClickError(code int, button C.MMMouseButton, stage string, double bool) error {
func formatClickError(code int, button C.MMMouseButton, stage string, count int) error {
btnName := MouseButtonString(button)
detail := ""

Expand Down Expand Up @@ -776,10 +793,9 @@ func formatClickError(code int, button C.MMMouseButton, stage string, double boo
}

if detail != "" {
return fmt.Errorf("click %s failed (%s, double=%v): %s (code=%d)", stage, btnName, double, detail, code)
return fmt.Errorf("click %s failed (%s, count=%d): %s (code=%d)", stage, btnName, count, detail, code)
}

return fmt.Errorf("click %s failed (%s, double=%v), code=%d", stage, btnName, double, code)
return fmt.Errorf("click %s failed (%s, count=%d), code=%d", stage, btnName, count, code)
}

// MoveClick move and click the mouse
Expand Down Expand Up @@ -824,11 +840,14 @@ func Toggle(key ...interface{}) error {
if len(key) > 1 && key[1].(string) == "up" {
down = false
}
C.toggleMouse(C.bool(down), button)
code := C.toggleMouse(C.bool(down), button)
if code != 0 {
return formatClickError(int(code), button, "down", 1)
Copy link

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error stage is hardcoded to "down" even when the down parameter is false (indicating an "up" action). This will produce misleading error messages when a mouse up operation fails. The stage should be set to "up" when down is false.

Suggested change
return formatClickError(int(code), button, "down", 1)
stage := "down"
if !down {
stage = "up"
}
return formatClickError(int(code), button, stage, 1)

Copilot uses AI. Check for mistakes.
}

if len(key) > 2 {
MilliSleep(MouseSleep)
}

return nil
}

Expand Down
Loading