wineventhook 0.11.0

use std::{
    ffi::{c_long, c_ulong, c_void},
    fmt::{self, Debug},
    ptr::NonNull,
    time::{Duration, Instant, SystemTime},
};

use num_enum::{FromPrimitive, IntoPrimitive};
use windows_sys::Win32::{
    Foundation::HWND,
    System::SystemInformation::GetTickCount,
    UI::{Accessibility::HWINEVENTHOOK, WindowsAndMessaging},
};

use crate::raw_event;

/// A raw handle to a hook created using [`SetWinEventHook`](https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-setwineventhook).
pub type RawHookHandle = HWINEVENTHOOK;

/// A non null handle to a hook created using [`SetWinEventHook`](https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-setwineventhook).
pub type HookHandle = NonNull<c_void>;

/// A raw handle to a window.
pub type RawWindowHandle = HWND;

/// A non null handle to a window.
pub type WindowHandle = NonNull<c_void>;

/// A raw window event received by a [`WindowEventHook`](crate::WindowEventHook).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct RawWindowEvent {
    /// Handle to the shared event hook function.
    pub hook_handle: HWINEVENTHOOK,
    /// Specifies the event that occurred
    pub event_id: c_ulong,
    /// Handle to the window that generates the event, or `NULL` if no window is associated with the event.
    /// For example, the mouse pointer is not associated with a window.
    pub window_handle: HWND,
    /// Identifies the object associated with the event.
    pub object_id: c_long,
    /// Identifies whether the event was triggered by an object or a child element of the object.
    /// If this value is [`CHILDID_SELF`](WindowsAndMessaging::CHILDID_SELF), the event was triggered by the object; otherwise, this value is the child ID of the element that triggered the event.
    pub child_id: c_long,
    /// Identifies the thread that generated the event.
    pub thread_id: c_ulong,
    /// Specifies the time since system startup, in milliseconds, that the event was generated.
    pub timestamp: c_ulong,
}

unsafe impl Send for RawWindowEvent {}

#[derive(Clone, Copy, PartialEq, Eq, Hash)]
/// A window event received by a [`WindowEventHook`](crate::WindowEventHook).
pub struct WindowEvent {
    /// The raw underlying event.
    pub raw: RawWindowEvent,
}

impl Debug for WindowEvent {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut builder = f.debug_struct(stringify!(WindowEvent));
        let _ = builder.field("hook_handle", &self.hook_handle());
        let _ = builder.field("event_type", &self.event_type());
        let _ = builder.field("window_handle", &self.window_handle());
        let _ = builder.field("object_type", &self.object_type());
        let _ = builder.field("child_id", &self.child_id());
        let _ = builder.field("thread_id", &self.thread_id());
        let _ = builder.field("timestamp", &self.timestamp());
        builder.finish()
    }
}

impl WindowEvent {
    /// Creates a new [`WindowEvent`] from a raw event.
    #[must_use]
    pub fn from_raw(raw: RawWindowEvent) -> Self {
        Self { raw }
    }

    /// Returns the handle to the shared event hook function.
    #[must_use]
    pub fn hook_handle(&self) -> HookHandle {
        unsafe { HookHandle::new_unchecked(self.raw.hook_handle) }
    }

    /// Returns the type of event that occurred.
    #[must_use]
    pub fn event_type(&self) -> WindowEventType {
        (self.raw.event_id as i32).into()
    }

    /// Returns the handle to the window that generates the event, or [`None`] if no window is associated with the event.
    #[must_use]
    pub fn window_handle(&self) -> Option<WindowHandle> {
        NonNull::new(self.raw.window_handle.cast())
    }

    /// Returns the type of object associated with the event.
    #[must_use]
    pub fn object_type(&self) -> AccessibleObjectId {
        self.raw.object_id.into()
    }

    /// Returns the child ID of the element that triggered the event, or [`None`] if the event was generated by the object itself.
    #[must_use]
    pub fn child_id(&self) -> Option<i32> {
        const CHILDID_SELF: i32 = WindowsAndMessaging::CHILDID_SELF.cast_signed();
        match self.raw.child_id {
            CHILDID_SELF => None,
            n => Some(n),
        }
    }

    /// Returns the id of the thread that generated the event.
    #[must_use]
    pub fn thread_id(&self) -> u32 {
        self.raw.thread_id
    }

    /// Returns the timestamp of the event.
    #[must_use]
    pub fn timestamp(&self) -> Instant {
        let time_since_system_start = Duration::from_millis(u64::from(unsafe { GetTickCount() }));
        let event_time_relative_to_system_start =
            Duration::from_millis(u64::from(self.raw.timestamp));
        let now = Instant::now();
        let system_start_instant = now.checked_sub(time_since_system_start).unwrap_or_else(|| {
            // use unix epoch if Instant underflows, should never happen.
            let time_since_unix_epoch = SystemTime::UNIX_EPOCH.elapsed().unwrap();
            now.checked_sub(time_since_unix_epoch).unwrap()
        });
        system_start_instant + event_time_relative_to_system_start
    }
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, IntoPrimitive, FromPrimitive,
)]
#[repr(i32)]
/// The type of object associated with a window event.
pub enum AccessibleObjectId {
    /// An alert that is associated with a window or an application.
    Alert = -10,
    /// The text insertion bar (caret) in the window.
    Caret = -8,
    /// The window's client area.
    Client = -4,
    /// The mouse pointer.
    /// There is only one mouse pointer in the system, and it is not a child of any window.
    Cursor = -9,
    /// The window's horizontal scroll bar.
    HorizontalScroll = -6,
    /// In response to this object identifier, third-party applications can expose their own object model.
    /// Third-party applications can return any COM interface in response to this object identifier.
    NativeObjectModel = -16,
    /// The window's menu bar.
    Menu = -3,
    /// An object identifier that `Oleacc.dll` uses internally.
    /// For more information, see [Appendix F: Object Identifier Values for OBJID_QUERYCLASSNAMEIDX`](https://docs.microsoft.com/en-us/windows/win32/winauto/appendix-f--object-identifier-values-for-objid-queryclassnameidx).
    QueryClassNameIdx = -12,
    /// The window's size grip: an optional frame component located at the lower-right corner of the window frame.
    SizeGrip = -7,
    /// A sound object.
    /// Sound objects do not have screen locations or children, but they do have name and state attributes.
    /// They are children of the application that is playing the sound.
    Sound = -11,
    /// The window's system menu.
    SystemMenu = -1,
    /// The window's title bar.
    TitleBar = -2,
    /// The window's vertical scroll bar.
    VerticalScroll = -5,
    /// The window itself rather than a child object.
    Window = 0,

    /// Unknown object id
    #[num_enum(catch_all)]
    Other(i32),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[non_exhaustive]
/// The type of window event.
/// See [Event Constants](https://docs.microsoft.com/en-us/windows/win32/winauto/event-constants), [System-Level and Object-Level Events](https://docs.microsoft.com/en-us/windows/win32/winauto/system-level-and-object-level-events) and [Allocation of WinEvent IDs](https://docs.microsoft.com/en-us/windows/win32/winauto/allocation-of-winevent-ids) for more information.
pub enum WindowEventType {
    /// An event describing a situation affecting all applications in the system.
    System(SystemWindowEvent),
    /// An event describing an OEM defined event.
    OemDefined(i32),
    /// An event indicating a change in a console window.
    Console(ConsoleWindowEvent),
    /// An UI Automation event.
    UiaEvent(i32),
    /// An Ui Automation property change event.
    UiaPropertyChange(i32),
    /// An event pertaining to a situation specific to objects within one application.
    Object(ObjectWindowEvent),
    /// An event that was allocated at runtime through the UI Automation extensibility API using [`GlobalAddAtom`](https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-globaladdatoma).
    Atom(i32),
    /// An event defined by Accessibility Interoperability Alliance (AIA) specifications.
    Aia(i32),
    /// An unknown event.
    Other(i32),
    // TODO: add community reserved event range
}

impl From<i32> for WindowEventType {
    fn from(number: i32) -> Self {
        if raw_event::all_system().contains(&number) {
            Self::System(SystemWindowEvent::from(number))
        } else if raw_event::all_console().contains(&number) {
            Self::Console(ConsoleWindowEvent::from(number))
        } else if raw_event::all_object().contains(&number) {
            Self::Object(ObjectWindowEvent::from(number))
        } else if raw_event::all_atom().contains(&number) {
            Self::Atom(number)
        } else if raw_event::all_aia().contains(&number) {
            Self::Aia(number)
        } else if raw_event::all_oem_defined().contains(&number) {
            Self::OemDefined(number)
        } else if raw_event::all_uia_event().contains(&number) {
            Self::UiaEvent(number)
        } else if raw_event::all_uia_property_change().contains(&number) {
            Self::UiaPropertyChange(number)
        } else {
            Self::Other(number)
        }
    }
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, IntoPrimitive, FromPrimitive,
)]
#[repr(i32)]
/// A known event describing a situation affecting all applications in the system.
pub enum SystemWindowEvent {
    /// A sound has been played.
    Sound = raw_event::SYSTEM_SOUND,

    /// An alert has been generated.
    Alert = raw_event::SYSTEM_ALERT,

    /// The foreground window has changed.
    Foreground = raw_event::SYSTEM_FOREGROUND,

    /// A menu item on the menu bar has been selected.
    MenuStart = raw_event::SYSTEM_MENUSTART,

    /// A menu from the menu bar has been closed.
    MenuEnd = raw_event::SYSTEM_MENUEND,

    /// A pop-up menu has been displayed.
    MenuPopupStart = raw_event::SYSTEM_MENUPOPUPSTART,

    /// A pop-up menu has been closed.
    MenuPopupEnd = raw_event::SYSTEM_MENUPOPUPEND,

    /// A window has received mouse capture.
    CaptureStart = raw_event::SYSTEM_CAPTURESTART,

    /// A window has lost mouse capture.
    CaptureEnd = raw_event::SYSTEM_CAPTUREEND,

    /// A window is being moved or resized.
    MoveSizeStart = raw_event::SYSTEM_MOVESIZESTART,

    /// The movement or resizing of a window has finished.
    MoveSizeEnd = raw_event::SYSTEM_MOVESIZEEND,

    /// A window has entered context-sensitive Help mode.
    ContextHelpStart = raw_event::SYSTEM_CONTEXTHELPSTART,

    /// A window has exited context-sensitive Help mode.
    ContextHelpEnd = raw_event::SYSTEM_CONTEXTHELPEND,

    /// An application is about to enter drag-and-drop mode.
    DragDropStart = raw_event::SYSTEM_DRAGDROPSTART,

    /// An application is about to exit drag-and-drop mode.
    DragDropEnd = raw_event::SYSTEM_DRAGDROPEND,

    /// A dialog box has been displayed.
    DialogStart = raw_event::SYSTEM_DIALOGSTART,

    /// An application is about to exit drag-and-drop mode.
    DialogEnd = raw_event::SYSTEM_DIALOGEND,

    /// Scrolling has started on a scroll bar.
    ScrollingStart = raw_event::SYSTEM_SCROLLINGSTART,

    /// Scrolling has ended on a scroll bar.
    ScrollingEnd = raw_event::SYSTEM_SCROLLINGEND,

    /// The user has pressed ALT+TAB, which activates the switch window.
    SwitchStart = raw_event::SYSTEM_SWITCHSTART,

    /// The user has released ALT+TAB.
    SwitchEnd = raw_event::SYSTEM_SWITCHEND,

    /// A window object is about to be minimized.
    MinimizeStart = raw_event::SYSTEM_MINIMIZESTART,

    /// A window object is about to be restored.
    MinimizeEnd = raw_event::SYSTEM_MINIMIZEEND,

    /// The active desktop has been switched.
    DesktopSwitch = raw_event::SYSTEM_DESKTOPSWITCH,

    /// Unknown event type
    #[num_enum(catch_all)]
    Other(i32),
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, IntoPrimitive, FromPrimitive,
)]
#[repr(i32)]
#[allow(missing_docs)]
/// A known event indicating a change in a console window.
pub enum ConsoleWindowEvent {
    Caret = raw_event::CONSOLE_CARET,
    UpdateRegion = raw_event::CONSOLE_UPDATE_REGION,
    UpdateSimple = raw_event::CONSOLE_UPDATE_SIMPLE,
    UpdateScroll = raw_event::CONSOLE_UPDATE_SCROLL,
    Layout = raw_event::CONSOLE_LAYOUT,
    StartApplication = raw_event::CONSOLE_START_APPLICATION,
    EndApplication = raw_event::CONSOLE_END_APPLICATION,

    /// Unknown event type
    #[num_enum(catch_all)]
    Other(i32),
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, IntoPrimitive, FromPrimitive,
)]
#[repr(i32)]
/// A known event indicating a change in a console window.
pub enum ObjectWindowEvent {
    /// An object has been created.
    Create = raw_event::OBJECT_CREATE,

    /// An object has been destroyed.
    Destroy = raw_event::OBJECT_DESTROY,

    /// A hidden object is shown.
    Show = raw_event::OBJECT_SHOW,

    /// An object is hidden.
    Hide = raw_event::OBJECT_HIDE,

    /// A container object has added, removed, or reordered its children.
    Reorder = raw_event::OBJECT_REORDER,

    /// An object has received the keyboard focus.
    Focus = raw_event::OBJECT_FOCUS,

    /// The selection within a container object has changed.
    Selection = raw_event::OBJECT_SELECTION,

    /// A child within a container object has been added to an existing selection.
    SelectionAdd = raw_event::OBJECT_SELECTIONADD,

    /// An item within a container object has been removed from the selection.
    SelectionRemove = raw_event::OBJECT_SELECTIONREMOVE,

    /// Numerous selection changes have occurred within a container object.
    SelectionWithin = raw_event::OBJECT_SELECTIONWITHIN,

    /// An object's state has changed.
    StateChange = raw_event::OBJECT_STATECHANGE,

    /// An object has changed location, shape, or size.
    LocationChange = raw_event::OBJECT_LOCATIONCHANGE,

    /// An object's Name property has changed.
    NameChange = raw_event::OBJECT_NAMECHANGE,

    /// An object's Description property has changed.
    DescriptionChange = raw_event::OBJECT_DESCRIPTIONCHANGE,

    /// An object's Value property has changed.
    ValueChange = raw_event::OBJECT_VALUECHANGE,

    /// An object has a new parent object.
    ParentChange = raw_event::OBJECT_PARENTCHANGE,

    /// An object's Help property has changed.
    HelpChange = raw_event::OBJECT_HELPCHANGE,

    /// An object's DefaultAction property has changed.
    DefaultActionChange = raw_event::OBJECT_DEFACTIONCHANGE,

    /// An object's KeyboardShortcut property has changed.
    AcceloratorChange = raw_event::OBJECT_ACCELERATORCHANGE,

    /// An object has been invoked; for example, the user has clicked a button.
    Invoked = raw_event::OBJECT_INVOKED,

    /// An object's text selection has changed.
    TextSelectionChanged = raw_event::OBJECT_TEXTSELECTIONCHANGED,

    /// A window object's scrolling has ended.
    ContentScrolled = raw_event::OBJECT_CONTENTSCROLLED,

    /// A preview rectangle is being displayed.
    ArrangementPreview = raw_event::SYSTEM_ARRANGMENTPREVIEW,

    /// Sent when a window is cloaked.
    /// A cloaked window still exists, but is invisible to the user.
    Cloaked = raw_event::OBJECT_CLOAKED,

    /// Sent when a window is uncloaked.
    /// A cloaked window still exists, but is invisible to the user.
    Uncloaked = raw_event::OBJECT_UNCLOAKED,

    /// An object that is part of a live region has changed.
    /// A live region is an area of an application that changes frequently and/or asynchronously.
    LiveRegionChanged = raw_event::OBJECT_LIVEREGIONCHANGED,

    /// A window that hosts other accessible objects has changed the hosted objects.
    HostedObjectsInvalidated = raw_event::OBJECT_HOSTEDOBJECTSINVALIDATED,

    /// The user started to drag an element.
    DragStart = raw_event::OBJECT_DRAGSTART,

    /// The user has ended a drag operation before dropping the dragged element on a drop target.
    DragCancel = raw_event::OBJECT_DRAGCANCEL,

    /// The user dropped an element on a drop target.
    DragComplete = raw_event::OBJECT_DRAG_COMPLETE,

    /// The user dragged an element into a drop target's boundary.
    DragEnter = raw_event::OBJECT_DRAGENTER,

    /// The user dragged an element out of a drop target's boundary.
    DragLeave = raw_event::OBJECT_DRAGLEAVE,

    /// The user dropped an element on a drop target.
    DragDropped = raw_event::OBJECT_DRAGDROPPED,

    /// An IME window has become visible.
    ImeShow = raw_event::OBJECT_IME_SHOW,

    /// An IME window has become hidden.
    ImeHide = raw_event::OBJECT_IME_HIDE,

    /// The size or position of an IME window has changed.
    ImeChange = raw_event::OBJECT_IME_CHANGE,

    /// The conversion target within an IME composition has changed.
    /// The conversion target is the subset of the IME composition which is actively selected as the target for user-initiated conversions.
    TextEditConversionTargetChanged = raw_event::OBJECT_TEXTEDIT_CONVERSIONTARGETCHANGED,

    /// Unknown event type
    #[num_enum(catch_all)]
    Other(i32),
}