inputflow 0.1.1

inputflow user input abstract plugin framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

use crate::{error::Result, key_types::{KeyboardKey,MouseButton}};
pub use abi_stable::type_layout::TypeLayout;
use cglue::prelude::v1::*;

#[cfg_attr(feature = "plugins", cglue_trait, cglue_forward)] //
/// Main interface for loadable plugins
pub trait Loadable {
    // type Instance: StableAbi;
    // type InputArg;
    // type CInputArg: StableAbi;
    // type ArgsType;

    fn name(&self) -> abi_stable::std_types::RString;
    /// U8 bitflags of capabilities. Sadly I have not yet figured out how to get the bitflags crate to play nice with abi_stable so this is base type for now
    fn capabilities(&self) -> u8;
}

cglue_trait_group!(ControllerFeatures, { Loadable }, { KeyboardWriter, MouseWriter, Clone });

/// Provides ability to send keyboard input to a device (local or external).
#[cfg_attr(feature = "plugins", cglue_trait, cglue_forward)]
#[int_result]
pub trait KeyboardWriter: Send {
    /// Sends keyboard press down event
    fn send_key_down(&mut self, key: KeyboardKey) -> Result<()>;

    /// Releases a key that was set to down previously
    fn send_key_up(&mut self, key: KeyboardKey) -> Result<()>;

    /// Presses a key and lets it go all in one for when users do not care about specific timings
    fn press_key(&mut self, key: KeyboardKey) -> Result<()>;

    /// clears all active pressed keys. Useful for cleaning up multiple keys presses in one go.
    /// Ensures that keyboard writer is set back into a neutral state.
    fn clear_keys(&mut self) -> Result<()>;
}

// TODO Later on. For now, memflow handles this.
// #[cfg_attr(feature = "plugins", cglue_trait)]
// pub trait KeyboardReader {
//
// }

/// Provides ability to send mouse button input to a device (local or external).
/// Also allows mouse movement input
#[cfg_attr(feature = "plugins", cglue_trait, cglue_forward)]
#[int_result]
pub trait MouseWriter: Send {
    /// Sends mouse button press down event
    fn send_button_down(&mut self, key: MouseButton) -> Result<()>;

    /// Releases a mouse button that was set to down previously
    fn send_button_up(&mut self, key: MouseButton) -> Result<()>;

    /// Presses a  mouse button and lets it go all in one for when users do not care about specific timings
    fn click_button(&mut self, key: MouseButton) -> Result<()>;

    /// clears all active pressed  mouse buttons. Useful for cleaning up multiple mouse button presses in one go.
    /// Ensures that mouse writer is set back into a neutral state.
    fn clear_buttons(&mut self) -> Result<()>;

    // mouse move abilities (might make this a separate trait. Undecided):

    /// Sends a mouse move command to move it x dpi-pixels horizontally, and y vertically
    fn mouse_move_relative(&mut self, x: i32, y: i32) -> Result<()>;
}

// TODO Later on. For now, memflow handles this.
// #[cfg_attr(feature = "plugins", cglue_trait)]
// pub trait MouseReader {
//
// }