autopilot 0.4.1

A simple, cross-platform GUI automation library for Rust.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

// Copyright 2018, 2019, 2020 Michael Sanders
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// https://apache.org/licenses/LICENSE-2.0> or the MIT License <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//
//! This module contains functions for working with the screen.
extern crate image;
use self::image::{GenericImageView, ImageResult, Rgba};
use bitmap;
use geometry::{Point, Rect, Size};

#[cfg(target_os = "macos")]
use core_graphics::display::CGDisplay;
#[cfg(target_os = "linux")]
use internal;

/// Returns the size of the main screen in points.
pub fn size() -> Size {
    system_size()
}

/// Returns the scale of the main screen, i.e. how many pixels are in a point.
pub fn scale() -> f64 {
    system_scale()
}

/// Returns whether the given point is inside the main screen boundaries.
pub fn is_point_visible(point: Point) -> bool {
    Rect::new(Point::ZERO, size()).is_point_visible(point)
}

/// Returns whether the given rect is inside the main screen boundaries.
pub fn is_rect_visible(rect: Rect) -> bool {
    Rect::new(Point::ZERO, size()).is_rect_visible(rect)
}

/// A convenience method that returns the RGB color at the given point on the
/// main display.
pub fn get_color(point: Point) -> ImageResult<Rgba<u8>> {
    let bmp = bitmap::capture_screen_portion(Rect::new(point, Size::new(1.0, 1.0)))?;
    Ok(bmp.image.get_pixel(0, 0))
}

#[cfg(target_os = "macos")]
fn system_size() -> Size {
    Size::from(CGDisplay::main().bounds().size)
}

#[cfg(target_os = "macos")]
fn system_scale() -> f64 {
    let mode = CGDisplay::main().display_mode().unwrap();
    mode.pixel_height() as f64 / mode.height() as f64
}

#[cfg(windows)]
fn system_size() -> Size {
    use winapi::um::winuser::{GetSystemMetrics, SM_CXSCREEN, SM_CYSCREEN};
    let scale_factor = scale();
    let width = f64::from(unsafe { GetSystemMetrics(SM_CXSCREEN) });
    let height = f64::from(unsafe { GetSystemMetrics(SM_CYSCREEN) });
    Size::new(width, height).scaled(1.0 / scale_factor)
}

#[cfg(windows)]
fn system_scale() -> f64 {
    use std::ffi::CString;
    use winapi::shared::minwindef::FARPROC;
    use winapi::um::libloaderapi::{GetProcAddress, LoadLibraryA};
    use winapi::um::winuser::GetDesktopWindow;
    let user32_c_str = CString::new("user32.dll").unwrap();
    let set_process_dpi_aware_c_str = CString::new("SetProcessDPIAware").unwrap();
    let get_dpi_for_window_c_str = CString::new("GetDpiForWindow").unwrap();
    let user32_module = unsafe { LoadLibraryA(user32_c_str.as_ptr()) };
    let set_process_dpi_aware_ptr: FARPROC =
        unsafe { GetProcAddress(user32_module, set_process_dpi_aware_c_str.as_ptr()) };
    let get_dpi_for_window_ptr: FARPROC =
        unsafe { GetProcAddress(user32_module, get_dpi_for_window_c_str.as_ptr()) };

    // Guard against old Windows versions.
    if !set_process_dpi_aware_ptr.is_null() && !get_dpi_for_window_ptr.is_null() {
        let set_process_dpi_aware: SetProcessDPIAwareSignature =
            unsafe { std::mem::transmute(set_process_dpi_aware_ptr) };
        let get_dpi_for_window: GetDPIForWindowSignature =
            unsafe { std::mem::transmute(get_dpi_for_window_ptr) };
        unsafe { set_process_dpi_aware() };
        let window = unsafe { GetDesktopWindow() };
        let dpi = unsafe { get_dpi_for_window(window) };
        f64::from(dpi) / 96.0
    } else {
        1.0
    }
}

#[cfg(target_os = "linux")]
fn system_size() -> Size {
    internal::X_MAIN_DISPLAY.with(|display| unsafe {
        let scale_factor = scale();
        let screen = x11::xlib::XDefaultScreen(display.as_ptr());
        let width = f64::from(x11::xlib::XDisplayWidth(display.as_ptr(), screen));
        let height = f64::from(x11::xlib::XDisplayHeight(display.as_ptr(), screen));
        Size::new(width, height).scaled(1.0 / scale_factor)
    })
}

#[cfg(target_os = "linux")]
fn system_scale() -> f64 {
    internal::X_SCALE_FACTOR.with(|scale| *scale)
}

#[cfg(windows)]
use libc;
#[cfg(windows)]
use winapi::shared::windef::HWND;

#[cfg(windows)]
type SetProcessDPIAwareSignature = unsafe extern "C" fn();
#[cfg(windows)]
type GetDPIForWindowSignature = unsafe extern "C" fn(HWND) -> libc::c_uint;