rustautogui 2.5.0

use crate::core::keyboard::get_keymap_key;
use crate::errors::AutoGuiError;
use std::{collections::HashMap, mem::size_of, thread::sleep, time::Duration};
use winapi::um::wingdi::SRCAND;
use winapi::um::winuser::{MapVirtualKeyW, MAPVK_VK_TO_VSC};
use winapi::um::winuser::{
    SendInput, INPUT, INPUT_KEYBOARD, KEYEVENTF_KEYUP, KEYEVENTF_SCANCODE, VK_CONTROL, VK_MENU,
    VK_SHIFT,
};

/// main struct for interacting with keyboard. Keymap is generated upon intialization.
#[derive(Debug)]
pub struct Keyboard {
    pub keymap: HashMap<String, (u16, bool)>,
}
impl Keyboard {
    /// create new keyboard instance.
    pub fn new() -> Keyboard {
        let keyset = Keyboard::create_keymap();
        Keyboard { keymap: keyset }
    }

    unsafe fn press_key(scan_code: &u16) {
        let mut input: INPUT = std::mem::zeroed();
        input.type_ = INPUT_KEYBOARD;
        {
            let scan_code = *scan_code;
            let ki = input.u.ki_mut();
            if scan_code == VK_SHIFT as u16
                || scan_code == VK_CONTROL as u16
                || scan_code == VK_MENU as u16
            {
                ki.wVk = scan_code; // Use virtual key code for Shift, Control, and Alt
                ki.wScan = 0;
                ki.dwFlags = 0; // No KEYEVENTF_SCANCODE flag for virtual key
            } else {
                let scan_code = MapVirtualKeyW(scan_code as u32, MAPVK_VK_TO_VSC) as u16;
                ki.wVk = 0;
                ki.wScan = scan_code;
                ki.dwFlags = KEYEVENTF_SCANCODE;
            }
            ki.time = 0;
            ki.dwExtraInfo = 0;
        }

        // Send key press
        SendInput(1, &mut input, size_of::<INPUT>() as i32);
    }

    unsafe fn release_key(scan_code: &u16) {
        let mut input: INPUT = std::mem::zeroed();
        input.type_ = INPUT_KEYBOARD;
        {
            let scan_code = *scan_code;
            let ki = input.u.ki_mut();
            if scan_code == VK_SHIFT as u16
                || scan_code == VK_CONTROL as u16
                || scan_code == VK_MENU as u16
            {
                ki.wVk = scan_code; // Use virtual key code for Shift, Control, and Alt
                ki.wScan = 0;
                ki.dwFlags = KEYEVENTF_KEYUP; // No KEYEVENTF_SCANCODE flag for virtual key
            } else {
                let scan_code = MapVirtualKeyW(scan_code as u32, MAPVK_VK_TO_VSC) as u16;
                ki.wVk = 0;
                ki.wScan = scan_code;
                ki.dwFlags = KEYEVENTF_SCANCODE | KEYEVENTF_KEYUP;
            }
            ki.time = 0;
            ki.dwExtraInfo = 0;
        }

        // Release key
        SendInput(1, &mut input, size_of::<INPUT>() as i32);
    }

    pub fn key_down(&self, key: &str) -> Result<(), AutoGuiError> {
        let (value, _) = get_keymap_key(self, key)?;
        unsafe {
            Keyboard::press_key(value);
        }
        Ok(())
    }

    pub fn key_up(&self, key: &str) -> Result<(), AutoGuiError> {
        let (value, _) = get_keymap_key(self, key)?;
        unsafe {
            Keyboard::release_key(value);
        }
        Ok(())
    }

    /// executes press down of a key, then press up.
    pub fn send_key(scan_code: &u16) {
        unsafe {
            Keyboard::press_key(scan_code);
            Keyboard::release_key(scan_code);
        }
    }

    /// executes press down of shift key, press down and press up for desired key, then press up of shift key
    pub fn send_shifted_key(scan_code: &u16) {
        unsafe {
            Keyboard::press_key(&0x10); // shift press
            sleep(Duration::from_micros(50));
            // send key
            Keyboard::send_key(scan_code);
            sleep(Duration::from_micros(50));

            Keyboard::release_key(&0x10); // shift release
            sleep(Duration::from_micros(50));
        }
    }

    /// Function used when sending input as string. All characters need to be part of the key map, described in Keyboard_commands.md
    /// For each character in a string, Keyboard::send_key() is executed. If the character requires a shift key,
    /// Keyboard::send_shifted_key is executed
    pub fn send_char(&self, key: &char) -> Result<(), AutoGuiError> {
        let char_string = String::from(*key);
        let (value, shifted) = get_keymap_key(self, &char_string)?;

        if *shifted {
            Keyboard::send_shifted_key(value);
        } else {
            Keyboard::send_key(value);
        }
        Ok(())
    }

    /// Function used when sending commands like "return" or "escape"
    pub fn send_command(&self, key: &str) -> Result<(), AutoGuiError> {
        let (value, _) = get_keymap_key(self, key)?;
        Keyboard::send_key(value);
        Ok(())
    }

    pub fn send_multi_key(
        &self,
        key_1: &str,
        key_2: &str,
        key_3: Option<String>,
    ) -> Result<(), AutoGuiError> {
        let (value_1, _) = get_keymap_key(self, key_1)?;
        let (value_2, _) = get_keymap_key(self, key_2)?;

        let mut third_key = false;
        let value_3 = match key_3 {
            Some(value) => {
                third_key = true;
                let (value_, _) = get_keymap_key(self, &value)?;
                value_
            }
            None => &0,
        };

        unsafe {
            Keyboard::press_key(value_1);
            Keyboard::press_key(value_2);
            if third_key {
                Keyboard::press_key(value_3);
                Keyboard::release_key(value_3);
            }
            Keyboard::release_key(value_2);
            Keyboard::release_key(value_1);
        }
        Ok(())
    }

    /// mapping made so  bigger variety of strings can be used when sending string as input.
    /// for instance, instead of neccessity of sending "period", we can send ".". This means when sending a
    /// string like url test.hr we dont need to send test, then send period, then send hr
    pub fn create_keymap() -> HashMap<String, (u16, bool)> {
        let mut key_map: HashMap<String, (u16, bool)> = HashMap::new();
        // Inserting key mappings
        key_map.insert(String::from("backspace"), (0x08, false)); // VK_BACK
        key_map.insert(String::from("super"), (0x5B, false)); // VK_LWIN
        key_map.insert(String::from("tab"), (0x09, false)); // VK_TAB
        key_map.insert(String::from("clear"), (0x0c, false)); // VK_CLEAR
        key_map.insert(String::from("enter"), (0x0d, false)); // VK_RETURN
        key_map.insert(String::from("return"), (0x0d, false)); // VK_RETURN
        key_map.insert(String::from("shift_l"), (0x10, false)); // VK_SHIFT
        key_map.insert(String::from("ctrl"), (0x11, false)); // VK_CONTROL
        key_map.insert(String::from("alt"), (0x12, false)); // VK_MENU
        key_map.insert(String::from("pause"), (0x13, false)); // VK_PAUSE
        key_map.insert(String::from("caps_lock"), (0x14, false)); // VK_CAPITAL
        key_map.insert(String::from("kana"), (0x15, false)); // VK_KANA
        key_map.insert(String::from("hanguel"), (0x15, false)); // VK_HANGUEL
        key_map.insert(String::from("hangul"), (0x15, false)); // VK_HANGUL
        key_map.insert(String::from("junja"), (0x17, false)); // VK_JUNJA
        key_map.insert(String::from("final"), (0x18, false)); // VK_FINAL
        key_map.insert(String::from("hanja"), (0x19, false)); // VK_HANJA
        key_map.insert(String::from("kanji"), (0x19, false)); // VK_KANJI
        key_map.insert(String::from("esc"), (0x1b, false)); // VK_ESCAPE
        key_map.insert(String::from("escape"), (0x1b, false)); // VK_ESCAPE
        key_map.insert(String::from("convert"), (0x1c, false)); // VK_CONVERT
        key_map.insert(String::from("nonconvert"), (0x1d, false)); // VK_NONCONVERT
        key_map.insert(String::from("accept"), (0x1e, false)); // VK_ACCEPT
        key_map.insert(String::from("modechange"), (0x1f, false)); // VK_MODECHANGE
        key_map.insert(String::from(" "), (0x20, false)); // VK_SPACE
        key_map.insert(String::from("space"), (0x20, false)); // VK_SPACE
        key_map.insert(String::from("pgup"), (0x21, false)); // VK_PRIOR
        key_map.insert(String::from("pgdn"), (0x22, false)); // VK_NEXT
        key_map.insert(String::from("page_up"), (0x21, false)); // VK_PRIOR
        key_map.insert(String::from("page_down"), (0x22, false)); // VK_NEXT
        key_map.insert(String::from("end"), (0x23, false)); // VK_END
        key_map.insert(String::from("home"), (0x24, false)); // VK_HOME
        key_map.insert(String::from("left_arrow"), (0x25, false)); // VK_LEFT
        key_map.insert(String::from("up_arrow"), (0x26, false)); // VK_UP
        key_map.insert(String::from("right_arrow"), (0x27, false)); // VK_RIGHT
        key_map.insert(String::from("down_arrow"), (0x28, false)); // VK_DOWN

        key_map.insert(String::from("left"), (0x25, false)); // VK_LEFT
        key_map.insert(String::from("up"), (0x26, false)); // VK_UP
        key_map.insert(String::from("right"), (0x27, false)); // VK_RIGHT
        key_map.insert(String::from("down"), (0x28, false)); // VK_DOWN

        key_map.insert(String::from("select"), (0x29, false)); // VK_SELECT
        key_map.insert(String::from("print"), (0x2a, false)); // VK_PRINT
        key_map.insert(String::from("execute"), (0x2b, false)); // VK_EXECUTE
        key_map.insert(String::from("prtsc"), (0x2c, false)); // VK_SNAPSHOT
        key_map.insert(String::from("prtscr"), (0x2c, false)); // VK_SNAPSHOT
        key_map.insert(String::from("prntscrn"), (0x2c, false)); // VK_SNAPSHOT
        key_map.insert(String::from("printscreen"), (0x2c, false)); // VK_SNAPSHOT
        key_map.insert(String::from("insert"), (0x2d, false)); // VK_INSERT
        key_map.insert(String::from("del"), (0x2e, false)); // VK_DELETE
        key_map.insert(String::from("delete"), (0x2e, false)); // VK_DELETE
        key_map.insert(String::from("help"), (0x2f, false)); // VK_HELP
        key_map.insert(String::from("win"), (0x5b, false)); // VK_LWIN
        key_map.insert(String::from("winleft"), (0x5b, false)); // VK_LWIN
        key_map.insert(String::from("win_l"), (0x5b, false)); // VK_LWIN
        key_map.insert(String::from("super"), (0x5b, false)); // VK_LWIN
        key_map.insert(String::from("super_l"), (0x5b, false)); // VK_LWIN
        key_map.insert(String::from("winright"), (0x5c, false)); // VK_RWIN
        key_map.insert(String::from("win_r"), (0x5c, false)); // VK_RWIN
        key_map.insert(String::from("super_r"), (0x5c, false)); // VK_RWIN
        key_map.insert(String::from("apps"), (0x5d, false)); // VK_APPS
        key_map.insert(String::from("sleep"), (0x5f, false)); // VK_SLEEP
        key_map.insert(String::from("num0"), (0x60, false)); // VK_NUMPAD0
        key_map.insert(String::from("num1"), (0x61, false)); // VK_NUMPAD1
        key_map.insert(String::from("num2"), (0x62, false)); // VK_NUMPAD2
        key_map.insert(String::from("num3"), (0x63, false)); // VK_NUMPAD3
        key_map.insert(String::from("num4"), (0x64, false)); // VK_NUMPAD4
        key_map.insert(String::from("num5"), (0x65, false)); // VK_NUMPAD5
        key_map.insert(String::from("num6"), (0x66, false)); // VK_NUMPAD6
        key_map.insert(String::from("num7"), (0x67, false)); // VK_NUMPAD7
        key_map.insert(String::from("num8"), (0x68, false)); // VK_NUMPAD8
        key_map.insert(String::from("num9"), (0x69, false)); // VK_NUMPAD9
        key_map.insert(String::from("*"), (0x6a, false)); //,false) VK_MULTIPLY
        key_map.insert(String::from("+"), (0x6b, false)); //,false) VK_ADD
        key_map.insert(String::from("="), (0xBB, false)); //,false) VK_OEM plus

        key_map.insert(String::from("separator"), (0x6c, true)); // VK_SEPARATOR
        key_map.insert(String::from("-"), (0xBD, false)); //,false) VK_SUBTRACT
        key_map.insert(String::from("_"), (0xBD, true)); //,false) VK_SUBTRACT
        key_map.insert(String::from("."), (0xBE, false)); // VK_OEM_PERIOD
        key_map.insert(String::from(","), (0xBC, false)); // VK_OEM_COMMA
        key_map.insert(String::from(">"), (0xBE, true)); // VK_OEM_PERIOD
        key_map.insert(String::from("<"), (0xBC, true)); // VK_OEM_COMMA
        key_map.insert(String::from("/"), (0x6f, false)); // VK_DIVIDE
        key_map.insert(String::from("?"), (0x6f, true)); // VK_DIVIDE
        key_map.insert(String::from("f1"), (0x70, false)); // VK_F1
        key_map.insert(String::from("f2"), (0x71, false)); // VK_F2
        key_map.insert(String::from("f3"), (0x72, false)); // VK_F3
        key_map.insert(String::from("f4"), (0x73, false)); // VK_F4
        key_map.insert(String::from("f5"), (0x74, false)); // VK_F5
        key_map.insert(String::from("f6"), (0x75, false)); // VK_F6
        key_map.insert(String::from("f7"), (0x76, false)); // VK_F7
        key_map.insert(String::from("f8"), (0x77, false)); // VK_F8
        key_map.insert(String::from("f9"), (0x78, false)); // VK_F9
        key_map.insert(String::from("f10"), (0x79, false)); // VK_F10
        key_map.insert(String::from("f11"), (0x7a, false)); // VK_F11
        key_map.insert(String::from("f12"), (0x7b, false)); // VK_F12
        key_map.insert(String::from("f13"), (0x7c, false)); // VK_F13
        key_map.insert(String::from("f14"), (0x7d, false)); // VK_F14
        key_map.insert(String::from("f15"), (0x7e, false)); // VK_F15
        key_map.insert(String::from("f16"), (0x7f, false)); // VK_F16
        key_map.insert(String::from("f17"), (0x80, false)); // VK_F17
        key_map.insert(String::from("f18"), (0x81, false)); // VK_F18
        key_map.insert(String::from("f19"), (0x82, false)); // VK_F19
        key_map.insert(String::from("f20"), (0x83, false)); // VK_F20
        key_map.insert(String::from("f21"), (0x84, false)); // VK_F21
        key_map.insert(String::from("f22"), (0x85, false)); // VK_F22
        key_map.insert(String::from("f23"), (0x86, false)); // VK_F23
        key_map.insert(String::from("f24"), (0x87, false)); // VK_F24
        key_map.insert(String::from("numlock"), (0x90, false)); // VK_NUMLOCK
        key_map.insert(String::from("scrolllock"), (0x91, false)); // VK_SCROLL
        key_map.insert(String::from("shift_l"), (0xa0, false)); // VK_LSHIFT
        key_map.insert(String::from("shift"), (0xa0, false)); // VK_LSHIFT
        key_map.insert(String::from("shift_r"), (0xa1, false)); // VK_RSHIFT
        key_map.insert(String::from("control_l"), (0xa2, false)); // VK_LCONTROL
        key_map.insert(String::from("control"), (0xa2, false)); // VK_LCONTROL
        key_map.insert(String::from("ctrl"), (0xa2, false)); // VK_LCONTROL
        key_map.insert(String::from("control_r"), (0xa3, false)); // VK_RCONTROL
        key_map.insert(String::from("alt_l"), (0xa4, false)); // VK_LMENU
        key_map.insert(String::from("alt"), (0xa4, false)); // VK_LMENU
        key_map.insert(String::from("alt_r"), (0xa5, false)); // VK_RMENU
        key_map.insert(String::from("browserback"), (0xa6, false)); // VK_BROWSER_BACK
        key_map.insert(String::from("browserforward"), (0xa7, false)); // VK_BROWSER_FORWARD
        key_map.insert(String::from("browserrefresh"), (0xa8, false)); // VK_BROWSER_REFRESH
        key_map.insert(String::from("browserstop"), (0xa9, false)); // VK_BROWSER_STOP
        key_map.insert(String::from("browsersearch"), (0xaa, false)); // VK_BROWSER_SEARCH
        key_map.insert(String::from("browserfavorites"), (0xab, false)); // VK_BROWSER_FAVORITES
        key_map.insert(String::from("browserhome"), (0xac, false)); // VK_BROWSER_HOME
        key_map.insert(String::from("volumemute"), (0xad, false)); // VK_VOLUME_MUTE
        key_map.insert(String::from("volumedown"), (0xae, false)); // VK_VOLUME_DOWN
        key_map.insert(String::from("volumeup"), (0xaf, false)); // VK_VOLUME_UP
        key_map.insert(String::from("nexttrack"), (0xb0, false)); // VK_MEDIA_NEXT_TRACK
        key_map.insert(String::from("prevtrack"), (0xb1, false)); // VK_MEDIA_PREV_TRACK
        key_map.insert(String::from("stop"), (0xb2, false)); // VK_MEDIA_STOP
        key_map.insert(String::from("playpause"), (0xb3, false)); // VK_MEDIA_PLAY_PAUSE
        key_map.insert(String::from("launchmail"), (0xb4, false)); // VK_LAUNCH_MAIL
        key_map.insert(String::from("launchmediaselect"), (0xb5, false)); // VK_LAUNCH_MEDIA_SELECT
        key_map.insert(String::from("launchapp1"), (0xb6, false)); // VK_LAUNCH_APP1
        key_map.insert(String::from("launchapp2"), (0xb7, false)); // VK_LAUNCH_APP2
        key_map.insert(String::from("a"), (0x41, false)); // A
        key_map.insert(String::from("b"), (0x42, false)); // B
        key_map.insert(String::from("c"), (0x43, false)); // C
        key_map.insert(String::from("d"), (0x44, false)); // D
        key_map.insert(String::from("e"), (0x45, false)); // E
        key_map.insert(String::from("f"), (0x46, false)); // F
        key_map.insert(String::from("g"), (0x47, false)); // G
        key_map.insert(String::from("h"), (0x48, false)); // H
        key_map.insert(String::from("i"), (0x49, false)); // I
        key_map.insert(String::from("j"), (0x4A, false)); // J
        key_map.insert(String::from("k"), (0x4B, false)); // K
        key_map.insert(String::from("l"), (0x4C, false)); // L
        key_map.insert(String::from("m"), (0x4D, false)); // M
        key_map.insert(String::from("n"), (0x4E, false)); // N
        key_map.insert(String::from("o"), (0x4F, false)); // O
        key_map.insert(String::from("p"), (0x50, false)); // P
        key_map.insert(String::from("q"), (0x51, false)); // Q
        key_map.insert(String::from("r"), (0x52, false)); // R
        key_map.insert(String::from("s"), (0x53, false)); // S
        key_map.insert(String::from("t"), (0x54, false)); // T
        key_map.insert(String::from("u"), (0x55, false)); // U
        key_map.insert(String::from("v"), (0x56, false)); // V
        key_map.insert(String::from("w"), (0x57, false)); // W
        key_map.insert(String::from("x"), (0x58, false)); // X
        key_map.insert(String::from("y"), (0x59, false)); // Y
        key_map.insert(String::from("z"), (0x5A, false)); // Z
        key_map.insert(String::from("A"), (0x41, true)); // A
        key_map.insert(String::from("B"), (0x42, true)); // B
        key_map.insert(String::from("C"), (0x43, true)); // C
        key_map.insert(String::from("D"), (0x44, true)); // D
        key_map.insert(String::from("E"), (0x45, true)); // E
        key_map.insert(String::from("F"), (0x46, true)); // F
        key_map.insert(String::from("G"), (0x47, true)); // G
        key_map.insert(String::from("H"), (0x48, true)); // H
        key_map.insert(String::from("I"), (0x49, true)); // I
        key_map.insert(String::from("J"), (0x4A, true)); // J
        key_map.insert(String::from("K"), (0x4B, true)); // K
        key_map.insert(String::from("L"), (0x4C, true)); // L
        key_map.insert(String::from("M"), (0x4D, true)); // M
        key_map.insert(String::from("N"), (0x4E, true)); // N
        key_map.insert(String::from("O"), (0x4F, true)); // O
        key_map.insert(String::from("P"), (0x50, true)); // P
        key_map.insert(String::from("Q"), (0x51, true)); // Q
        key_map.insert(String::from("R"), (0x52, true)); // R
        key_map.insert(String::from("S"), (0x53, true)); // S
        key_map.insert(String::from("T"), (0x54, true)); // T
        key_map.insert(String::from("U"), (0x55, true)); // U
        key_map.insert(String::from("V"), (0x56, true)); // V
        key_map.insert(String::from("W"), (0x57, true)); // W
        key_map.insert(String::from("X"), (0x58, true)); // X
        key_map.insert(String::from("Y"), (0x59, true)); // Y
        key_map.insert(String::from("Z"), (0x5A, true)); // Z
        key_map.insert(String::from("0"), (0x30, false)); // 0
        key_map.insert(String::from("1"), (0x31, false)); // 1
        key_map.insert(String::from("2"), (0x32, false)); // 2
        key_map.insert(String::from("3"), (0x33, false)); // 3
        key_map.insert(String::from("4"), (0x34, false)); // 4
        key_map.insert(String::from("5"), (0x35, false)); // 5
        key_map.insert(String::from("6"), (0x36, false)); // 6
        key_map.insert(String::from("7"), (0x37, false)); // 7
        key_map.insert(String::from("8"), (0x38, false)); // 8
        key_map.insert(String::from("9"), (0x39, false)); // 9
        key_map.insert(String::from("0"), (0x30, false)); // 0
        key_map.insert(String::from("!"), (0x31, true)); // 1
        key_map.insert(String::from("@"), (0x32, true)); // 2
        key_map.insert(String::from("#"), (0x33, true)); // 3
        key_map.insert(String::from("$"), (0x34, true)); // 4
        key_map.insert(String::from("%"), (0x35, true)); // 5
        key_map.insert(String::from("^"), (0x36, true)); // 6
        key_map.insert(String::from("&"), (0x37, true)); // 7
        key_map.insert(String::from("*"), (0x38, true)); // 8
        key_map.insert(String::from("("), (0x39, true)); // 9
        key_map.insert(String::from(")"), (0x30, true)); // 0
        key_map.insert(String::from(";"), (0xBA, false)); // VK_OEM_1
        key_map.insert(String::from(":"), (0xBA, true)); // VK_OEM_1
        key_map.insert(String::from("["), (0xDB, false)); // [ { VK_OEM_4
        key_map.insert(String::from("]"), (0xDD, false)); // ] } VK_OEM_6
        key_map.insert(String::from("\\"), (0xDC, false)); // \ | VK_OEM_5
        key_map.insert(String::from("'"), (0xDE, false)); // ' " VK_OEM_7
        key_map.insert(String::from("{"), (0xDB, true)); // [ { VK_OEM_4
        key_map.insert(String::from("}"), (0xDD, true)); // ] } VK_OEM_6
        key_map.insert(String::from("|"), (0xDC, true)); // \ | VK_OEM_5
        key_map.insert(String::from("\""), (0xDE, true)); // ' " VK_OEM_7
        key_map
    }
}