Skip to content
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

Adding support for relative mouse movement #181

Open
wants to merge 15 commits into
base: 1.3
Choose a base branch
from
Open

Adding support for relative mouse movement #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
543af4b
Adding a compile time option to use Unix epoch time for events.
kwhat Feb 17, 2022
0486808
input_hook.c:262:9: warning: implicit declaration of function ‘gettim…
kwhat Mar 8, 2022
f8b9d7d
Adding fix for click counter when using epoch time.
kwhat Mar 17, 2022
d67f056
Add an alternative logger callback which accepts va_list
TolikPylypchuk Mar 14, 2022
c890587
Request for void* argument in hook_set_logger_proc and hook_set_dispa…
kwhat Mar 19, 2022
e77cd6d
Remove USE_CARBON_LEGACY build flag. Fixes #127
kwhat Mar 19, 2022
102c266
hook_post_event should return an int for status UIOHOOK_SUCCESS or ot…
kwhat Mar 20, 2022
b4a7918
Change USE_OBJC flag to USE_APPKIT. Fixes #133
kwhat Mar 20, 2022
19c6f6d
Require XTest extension and remove support for XSendEvent. Fixes #123
kwhat Mar 20, 2022
795a917
X11 Dispatcher
kwhat Mar 26, 2022
45a5828
Refactoring dispatcher for Darwin.
kwhat Apr 26, 2022
b859ac8
Refactoring dispatcher for Windows.
kwhat Apr 24, 2022
f9a346c
Bug 139: Rotation value is always zero for mouse wheel events generat…
kwhat May 29, 2023
0635b69
Distinguish emulated input and user input (Bug #110)
kwhat Jul 12, 2023
6dcde72
Adding support for relative mouse movement (Bug #91)
kwhat Nov 26, 2023
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
53 changes: 7 additions & 46 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ endif()

add_library(uiohook
"src/logger.c"
"src/${UIOHOOK_SOURCE_DIR}/dispatch_event.c"
"src/${UIOHOOK_SOURCE_DIR}/input_helper.c"
"src/${UIOHOOK_SOURCE_DIR}/input_hook.c"
"src/${UIOHOOK_SOURCE_DIR}/post_event.c"
Expand Down Expand Up @@ -130,6 +131,10 @@ if(ENABLE_TEST)
target_link_libraries(uiohook_tests uiohook "${CMAKE_THREAD_LIBS_INIT}")
endif()

option(USE_EPOCH_TIME "Use Unix epoch time for event timestamps (default: ON)" ON)
if(USE_EPOCH_TIME)
add_compile_definitions(uiohook PRIVATE USE_EPOCH_TIME)
endif()

if(UNIX AND NOT APPLE)
find_package(PkgConfig REQUIRED)
Expand All @@ -148,26 +153,6 @@ if(UNIX AND NOT APPLE)
include(CheckIncludeFile)
check_include_file(X11/extensions/record.h HAVE_RECORD_H "-include X11/Xlib.h")

option(USE_XKB_COMMON "X Keyboard Common Extension (default: ON)" ON)
if(USE_XKB_COMMON)
pkg_check_modules(XKB_COMMON REQUIRED xkbcommon-x11)
add_compile_definitions(uiohook PRIVATE USE_XKB_COMMON)
target_include_directories(uiohook PRIVATE "${XKB_COMMON_INCLUDE_DIRS}")
target_link_libraries(uiohook "${XKB_COMMON_LDFLAGS}")

pkg_check_modules(X11_XCB REQUIRED x11-xcb)
target_include_directories(uiohook PRIVATE "${X11_XCB_INCLUDE_DIRS}")
target_link_libraries(uiohook "${X11_XCB_LDFLAGS}")
endif()

option(USE_XKB_FILE "X Keyboard File Extension (default: ON)" ON)
if(USE_XKB_FILE)
pkg_check_modules(XKB_FILE REQUIRED xkbfile)
add_compile_definitions(uiohook PRIVATE USE_XKB_FILE)
target_include_directories(uiohook PRIVATE "${XKB_FILE_INCLUDE_DIRS}")
target_link_libraries(uiohook "${XKB_FILE_LDFLAGS}")
endif()

option(USE_XT "X Toolkit Extension (default: ON)" ON)
if(USE_XT)
pkg_check_modules(XT REQUIRED xt)
Expand Down Expand Up @@ -206,12 +191,6 @@ if(UNIX AND NOT APPLE)
add_compile_definitions(uiohook PRIVATE USE_XRECORD_ASYNC)
endif()

option(USE_XTEST "XTest API (default: ON)" ON)
if(USE_XTEST)
# XTest API is provided by Xtst
add_compile_definitions(uiohook PRIVATE USE_XTEST)
endif()

if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
option(USE_EVDEV "Generic Linux input driver (default: ON)" ON)
if(USE_EVDEV)
Expand Down Expand Up @@ -245,31 +224,13 @@ elseif(APPLE)
target_link_libraries(uiohook "${IOKIT}")
endif()

# FIXME Change USE_OBJC flag to USE_APPKIT
#option(USE_APPKIT "AppKit framework (default: ON)" ON)
option(USE_OBJC "Objective-C API (default: ON)" ON)
if(USE_OBJC)
# FIXME Drop USE_OBJC as it is included in AppKit
find_library(OBJC objc REQUIRED)
add_compile_definitions(USE_OBJC)
target_include_directories(uiohook PRIVATE "${OBJC}")
target_link_libraries(uiohook "${OBJC}")

option(USE_APPKIT "AppKit framework (default: ON)" ON)
if(USE_APPKIT)
find_library(APPKIT AppKit REQUIRED)
add_compile_definitions(USE_APPKIT)
target_include_directories(uiohook PRIVATE "${APPKIT}")
target_link_libraries(uiohook "${APPKIT}")
endif()

option(USE_CARBON_LEGACY "Legacy Carbon framework functionality (default: OFF)" OFF)
if(USE_CARBON_LEGACY)
message(DEPRECATION "Legacy Carbon functionality has been deprecated.")
add_compile_definitions(USE_CARBON_LEGACY)

if(USE_CARBON_LEGACY AND CMAKE_SIZEOF_VOID_P EQUAL 8)
message(WARNING "Legacy Carbon functionality should not be used with 64-bit targets.")
endif()
endif()
elseif(WIN32)
target_link_libraries(uiohook Advapi32)
endif()
Expand Down
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,17 @@ $ cmake --build . --parallel 2 --target install
| __all__ | BUILD_DEMO:BOOL | demo applications | OFF |
| | BUILD_SHARED_LIBS:BOOL | shared library | ON |
| | ENABLE_TEST:BOOL | testing | OFF |
| | USE_EPOCH_TIME:BOOL | unix epch event times | OFF |
| __OSX__ | USE_APPLICATION_SERVICES:BOOL | framework | ON |
| | USE_IOKIT:BOOL | framework | ON |
| | USE_OBJC:BOOL | obj-c api | ON |
| | USE_CARBON_LEGACY:BOOL | legacy framework | OFF |
| | USE_APPKIT:BOOL | obj-c api | ON |
| __Win32__ | | | |
| __Linux__ | USE_EVDEV:BOOL | generic input driver | ON |
| __*nix__ | USE_XF86MISC:BOOL | xfree86-misc extension | OFF |
| | USE_XINERAMA:BOOL | xinerama library | ON |
| | USE_XKB_COMMON:BOOL | xkbcommon extension | ON |
| | USE_XKB_FILE:BOOL | xkb-file extension | ON |
| | USE_XRANDR:BOOL | xrandt extension | OFF |
| | USE_XRECORD_ASYNC:BOOL | xrecord async api | OFF |
| | USE_XT:BOOL | x toolkit extension | ON |
| | USE_XTEST:BOOL | xtest extension | ON |

## Usage
* [Hook Demo](demo/demo_hook.c)
Expand Down
91 changes: 48 additions & 43 deletions demo/demo_hook.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,33 @@
#endif

#include <inttypes.h>
#include <locale.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <uiohook.h>
#include <wchar.h>

bool logger_proc(unsigned int level, const char *format, ...) {
bool status = false;

va_list args;

static void logger_proc(unsigned int level, void *user_data, const char *format, va_list args) {
switch (level) {
case LOG_LEVEL_INFO:
va_start(args, format);
status = vfprintf(stdout, format, args) >= 0;
va_end(args);
vfprintf(stdout, format, args);
break;

case LOG_LEVEL_WARN:
case LOG_LEVEL_ERROR:
va_start(args, format);
status = vfprintf(stderr, format, args) >= 0;
va_end(args);
vfprintf(stderr, format, args);
break;
}

return status;
}

static void logger(unsigned int level, const char *format, ...) {
va_list args;

va_start(args, format);
logger_proc(level, NULL, format, args);
va_end(args);
}

// NOTE: The following callback executes on the same thread that hook_run() is called
Expand All @@ -56,12 +56,12 @@ bool logger_proc(unsigned int level, const char *format, ...) {
// Furthermore, some operating systems may choose to disable your hook if it
// takes too long to process. If you need to do any extended processing, please
// do so by copying the event to your own queued dispatch thread.
void dispatch_proc(uiohook_event * const event) {
void dispatch_proc(uiohook_event * const event, void *user_data) {
char buffer[256] = { 0 };
size_t length = snprintf(buffer, sizeof(buffer),
"id=%i,when=%" PRIu64 ",mask=0x%X",
event->type, event->time, event->mask);
"id=%i,when=%" PRIu64 ",mask=0x%X, reserved=0x%X",
event->type, event->time, event->mask, event->reserved);

switch (event->type) {
case EVENT_KEY_PRESSED:
// If the escape key is pressed, naturally terminate the program.
Expand All @@ -74,30 +74,30 @@ void dispatch_proc(uiohook_event * const event) {

// System level errors.
case UIOHOOK_ERROR_OUT_OF_MEMORY:
logger_proc(LOG_LEVEL_ERROR, "Failed to allocate memory. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to allocate memory. (%#X)", status);
break;

case UIOHOOK_ERROR_X_RECORD_GET_CONTEXT:
// NOTE This is the only platform specific error that occurs on hook_stop().
logger_proc(LOG_LEVEL_ERROR, "Failed to get XRecord context. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to get XRecord context. (%#X)", status);
break;

// Default error.
case UIOHOOK_FAILURE:
default:
logger_proc(LOG_LEVEL_ERROR, "An unknown hook error occurred. (%#X)", status);
logger(LOG_LEVEL_ERROR, "An unknown hook error occurred. (%#X)", status);
break;
}
}
case EVENT_KEY_RELEASED:
snprintf(buffer + length, sizeof(buffer) - length,
",keycode=%u,rawcode=0x%X",
",keycode=0x%X,rawcode=0x%X",
event->data.keyboard.keycode, event->data.keyboard.rawcode);
break;

case EVENT_KEY_TYPED:
snprintf(buffer + length, sizeof(buffer) - length,
",keychar=%lc,rawcode=%u",
",keychar=%lc,rawcode=0x%X",
(wint_t) event->data.keyboard.keychar,
event->data.keyboard.rawcode);
break;
Expand All @@ -107,32 +107,37 @@ void dispatch_proc(uiohook_event * const event) {
case EVENT_MOUSE_CLICKED:
case EVENT_MOUSE_MOVED:
case EVENT_MOUSE_DRAGGED:
snprintf(buffer + length, sizeof(buffer) - length,
snprintf(buffer + length, sizeof(buffer) - length,
",x=%i,y=%i,button=%i,clicks=%i",
event->data.mouse.x, event->data.mouse.y,
event->data.mouse.button, event->data.mouse.clicks);
break;

case EVENT_MOUSE_WHEEL:
snprintf(buffer + length, sizeof(buffer) - length,
",type=%i,amount=%i,rotation=%i",
event->data.wheel.type, event->data.wheel.amount,
event->data.wheel.rotation);
snprintf(buffer + length, sizeof(buffer) - length,
",type=%u,rotation=%i,delta=%u,direction=%u",
event->data.wheel.type,
event->data.wheel.rotation,
event->data.wheel.delta,
event->data.wheel.direction);
break;

default:
break;
}

fprintf(stdout, "%s\n", buffer);
fprintf(stdout, "%s\n", buffer);
}

int main() {
// Set the locale for unicode support.
setlocale(LC_ALL, "");

// Set the logger callback for library output.
hook_set_logger_proc(&logger_proc);
hook_set_logger_proc(&logger_proc, NULL);

// Set the event callback for uiohook events.
hook_set_dispatch_proc(&dispatch_proc);
hook_set_dispatch_proc(&dispatch_proc, NULL);

// Start the hook and block.
// NOTE If EVENT_HOOK_ENABLED was delivered, the status will always succeed.
Expand All @@ -144,63 +149,63 @@ int main() {

// System level errors.
case UIOHOOK_ERROR_OUT_OF_MEMORY:
logger_proc(LOG_LEVEL_ERROR, "Failed to allocate memory. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to allocate memory. (%#X)", status);
break;


// X11 specific errors.
case UIOHOOK_ERROR_X_OPEN_DISPLAY:
logger_proc(LOG_LEVEL_ERROR, "Failed to open X11 display. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to open X11 display. (%#X)", status);
break;

case UIOHOOK_ERROR_X_RECORD_NOT_FOUND:
logger_proc(LOG_LEVEL_ERROR, "Unable to locate XRecord extension. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Unable to locate XRecord extension. (%#X)", status);
break;

case UIOHOOK_ERROR_X_RECORD_ALLOC_RANGE:
logger_proc(LOG_LEVEL_ERROR, "Unable to allocate XRecord range. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Unable to allocate XRecord range. (%#X)", status);
break;

case UIOHOOK_ERROR_X_RECORD_CREATE_CONTEXT:
logger_proc(LOG_LEVEL_ERROR, "Unable to allocate XRecord context. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Unable to allocate XRecord context. (%#X)", status);
break;

case UIOHOOK_ERROR_X_RECORD_ENABLE_CONTEXT:
logger_proc(LOG_LEVEL_ERROR, "Failed to enable XRecord context. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to enable XRecord context. (%#X)", status);
break;


// Windows specific errors.
case UIOHOOK_ERROR_SET_WINDOWS_HOOK_EX:
logger_proc(LOG_LEVEL_ERROR, "Failed to register low level windows hook. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to register low level windows hook. (%#X)", status);
break;


// Darwin specific errors.
case UIOHOOK_ERROR_AXAPI_DISABLED:
logger_proc(LOG_LEVEL_ERROR, "Failed to enable access for assistive devices. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to enable access for assistive devices. (%#X)", status);
break;

case UIOHOOK_ERROR_CREATE_EVENT_PORT:
logger_proc(LOG_LEVEL_ERROR, "Failed to create apple event port. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to create apple event port. (%#X)", status);
break;

case UIOHOOK_ERROR_CREATE_RUN_LOOP_SOURCE:
logger_proc(LOG_LEVEL_ERROR, "Failed to create apple run loop source. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to create apple run loop source. (%#X)", status);
break;

case UIOHOOK_ERROR_GET_RUNLOOP:
logger_proc(LOG_LEVEL_ERROR, "Failed to acquire apple run loop. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to acquire apple run loop. (%#X)", status);
break;

case UIOHOOK_ERROR_CREATE_OBSERVER:
logger_proc(LOG_LEVEL_ERROR, "Failed to create apple run loop observer. (%#X)", status);
logger(LOG_LEVEL_ERROR, "Failed to create apple run loop observer. (%#X)", status);
break;

// Default error.
case UIOHOOK_FAILURE:
default:
logger_proc(LOG_LEVEL_ERROR, "An unknown hook error occurred. (%#X)", status);
logger(LOG_LEVEL_ERROR, "An unknown hook error occurred. (%#X)", status);
break;
}

Expand Down
Loading