https://github.com/kwhat/libuiohook

A multi-platform C library to provide global keyboard and mouse hooks from userland.
https://github.com/kwhat/libuiohook

c global-hotkeys keyboard-hooks mouse-hooks multi-platform

Last synced: 3 days ago
JSON representation

A multi-platform C library to provide global keyboard and mouse hooks from userland.

• Host: GitHub
• URL: https://github.com/kwhat/libuiohook
• Owner: kwhat
• License: other
• Created: 2013-09-28T02:49:54.000Z (over 11 years ago)
• Default Branch: 1.2
• Last Pushed: 2024-07-13T10:46:57.000Z (6 months ago)
• Last Synced: 2024-07-31T22:55:58.548Z (6 months ago)
• Topics: c, global-hotkeys, keyboard-hooks, mouse-hooks, multi-platform
• Language: C
• Homepage:
• Size: 1.75 MB
• Stars: 482
• Watchers: 17
• Forks: 122
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: COPYING.LESSER.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
libUIOHook: Cross-platform keyboard and mouse hooking from userland. 

====================================================================

![build-binaires](https://github.com/kwhat/libuiohook/workflows/build-binaires/badge.svg)

## Compiling

Prerequisites: 

 * [cmake](https://cmake.org)

 * gcc, clang or msvc

 * x11 dependencies:

   * libx11-dev

   * libxtst-dev

   * libxt-dev

   * libxinerama-dev

   * libx11-xcb-dev

   * libxkbcommon-dev

   * libxkbcommon-x11-dev

   * libxkbfile-dev 

```

$ git clone https://github.com/kwhat/libuiohook

$ cd libuiohook

$ mkdir build && cd build

$ cmake -S .. -D BUILD_SHARED_LIBS=ON -D BUILD_DEMO=ON -DCMAKE_INSTALL_PREFIX=../dist

$ cmake --build . --parallel 2 --target install  

```

### Configuration

|           | option                        | description            | default |

| --------- | ----------------------------- | ---------------------- | ------- | 

| __all__   | BUILD_DEMO:BOOL               | demo applications      | OFF     |

|           | BUILD_SHARED_LIBS:BOOL        | shared library         | ON      |

|           | ENABLE_TEST:BOOL              | testing                | 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     |

| __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)

* [Async Hook Demo](demo/demo_hook_async.c)

* [Event Post Demo](demo/demo_post.c)

* [Properties Demo](demo/demo_properties.c)

* [Public Interface](include/uiohook.h)

* Please see the man pages for function documentation.