chromey 2.37.182

Concurrent chrome devtools protocol automation library for Rust
Documentation
//! Code based on [rust-headless-chrome](https://github.com/atroche/rust-headless-chrome/blob/master/src/browser/tab/element/box_model.rs)

use chromiumoxide_cdp::cdp::browser_protocol::dom::Quad;
use chromiumoxide_cdp::cdp::browser_protocol::input::{
    DispatchMouseEventParams, DispatchMouseEventType, MouseButton,
};
use chromiumoxide_cdp::cdp::browser_protocol::page::Viewport;

#[derive(Debug, Copy, Clone, PartialEq)]
pub struct Point {
    /// The horizontal (X) coordinate.
    pub x: f64,
    /// The vertical (Y) coordinate.
    pub y: f64,
}

impl Point {
    /// Create a new Point instance
    pub fn new(x: f64, y: f64) -> Self {
        Self { x, y }
    }
    /// Get the signed area of the triangle formed with the origin and another point.
    fn area(&self, other: &Self) -> f64 {
        (self.x * other.y - other.x * self.y) / 2.
    }
}

impl std::ops::Add<Point> for Point {
    type Output = Self;

    fn add(self, other: Self) -> Self {
        Self {
            x: self.x + other.x,
            y: self.y + other.y,
        }
    }
}

impl std::ops::Sub<Point> for Point {
    type Output = Self;

    fn sub(self, other: Self) -> Self {
        Self {
            x: self.x - other.x,
            y: self.y - other.y,
        }
    }
}

impl std::ops::Div<f64> for Point {
    type Output = Self;

    fn div(self, other: f64) -> Self {
        Self {
            x: self.x / other,
            y: self.y / other,
        }
    }
}

#[derive(Default, Debug, Copy, Clone, PartialEq)]
pub struct Delta {
    /// X delta in CSS pixels for mouse wheel event (default: 0).
    pub delta_x: f64,
    /// Y delta in CSS pixels for mouse wheel event (default: 0).
    pub delta_y: f64,
}

impl Delta {
    /// Create a new Delta instance
    pub fn new(delta_x: f64, delta_y: f64) -> Self {
        Self { delta_x, delta_y }
    }

    pub fn area(&self, other: &Self) -> f64 {
        (self.delta_x * other.delta_y - other.delta_x * self.delta_y) / 2.
    }
}

/// Converts a point into Left-Down-Single-Mouseclick
impl From<Point> for DispatchMouseEventParams {
    fn from(el: Point) -> DispatchMouseEventParams {
        let mut params =
            DispatchMouseEventParams::new(DispatchMouseEventType::MousePressed, el.x, el.y);
        params.button = Some(MouseButton::Left);
        params.click_count = Some(1);
        params
    }
}

/// Represents the scroll behavior mode.
#[derive(Default, Debug, Clone, Copy)]
pub enum ScrollBehavior {
    #[default]
    Auto,
    Instant,
    Smooth,
}

#[derive(Debug, Copy, Clone)]
pub struct ElementQuad {
    pub top_left: Point,
    pub top_right: Point,
    pub bottom_right: Point,
    pub bottom_left: Point,
}

impl ElementQuad {
    pub fn from_quad(quad: &Quad) -> Self {
        assert_eq!(quad.inner().len(), 8);
        let raw_quad = quad.inner();
        Self {
            top_left: Point {
                x: raw_quad[0],
                y: raw_quad[1],
            },
            top_right: Point {
                x: raw_quad[2],
                y: raw_quad[3],
            },
            bottom_right: Point {
                x: raw_quad[4],
                y: raw_quad[5],
            },
            bottom_left: Point {
                x: raw_quad[6],
                y: raw_quad[7],
            },
        }
    }

    pub fn quad_center(&self) -> Point {
        Point {
            x: (self.top_left.x + self.top_right.x + self.bottom_right.x + self.bottom_left.x) / 4.,
            y: (self.top_left.y + self.top_right.y + self.bottom_right.y + self.bottom_left.y) / 4.,
        }
    }
    /// Compute sum of all directed areas of adjacent triangles
    /// https://en.wikipedia.org/wiki/Polygon#Simple_polygons
    pub fn quad_area(&self) -> f64 {
        let area = self.top_left.area(&self.top_right)
            + self.top_right.area(&self.bottom_right)
            + self.bottom_right.area(&self.bottom_left)
            + self.bottom_left.area(&self.top_left);
        area.abs()
    }

    /// Get the height of the shape based on the vertical distance
    /// between the top-left and bottom-left points.
    pub fn height(&self) -> f64 {
        self.bottom_left.y - self.top_left.y
    }

    /// Get the width of the shape based on the horizontal distance
    /// between the top-left and top-right points.
    pub fn width(&self) -> f64 {
        self.top_right.x - self.top_left.x
    }

    /// The width divided by the height
    pub fn aspect_ratio(&self) -> f64 {
        self.width() / self.height()
    }

    /// The most left (smallest) x-coordinate
    pub fn most_left(&self) -> f64 {
        self.top_right
            .x
            .min(self.top_left.x)
            .min(self.bottom_right.x)
            .min(self.bottom_left.x)
    }

    /// The most right (largest) x-coordinate
    pub fn most_right(&self) -> f64 {
        self.top_right
            .x
            .max(self.top_left.x)
            .max(self.bottom_right.x)
            .max(self.bottom_left.x)
    }

    /// The most top (smallest) y-coordinate
    pub fn most_top(&self) -> f64 {
        self.top_right
            .y
            .min(self.top_left.y)
            .min(self.bottom_right.y)
            .min(self.bottom_left.y)
    }

    /// The most bottom (largest) y-coordinate
    pub fn most_bottom(&self) -> f64 {
        self.top_right
            .y
            .max(self.top_left.y)
            .max(self.bottom_right.y)
            .max(self.bottom_left.y)
    }

    /// If the most bottom point of `self` is above the most top point of
    /// `other`
    pub fn strictly_above(&self, other: &Self) -> bool {
        self.most_bottom() < other.most_top()
    }

    /// If the most bottom point of `self` is above or on the same line as the
    /// most top point of `other`
    pub fn above(&self, other: &Self) -> bool {
        self.most_bottom() <= other.most_top()
    }

    /// If the most top point of `self` is below the most bottom point of
    /// `other`
    pub fn strictly_below(&self, other: &Self) -> bool {
        self.most_top() > other.most_bottom()
    }

    /// If the most top point of `self` is below or on the same line as the
    /// most bottom point of `other`
    pub fn below(&self, other: &Self) -> bool {
        self.most_top() >= other.most_bottom()
    }

    /// If the most right point of `self` is left of the most left point of
    /// `other`
    pub fn strictly_left_of(&self, other: &Self) -> bool {
        self.most_right() < other.most_left()
    }

    /// If the most right point of `self` is left or on the same line as the
    /// most left point of `other`
    pub fn left_of(&self, other: &Self) -> bool {
        self.most_right() <= other.most_left()
    }

    /// If the most left point of `self` is right of the most right point of
    /// `other`
    pub fn strictly_right_of(&self, other: &Self) -> bool {
        self.most_left() > other.most_right()
    }

    /// If the most left point of `self` is right or on the same line as the
    /// most right point of `other`
    pub fn right_of(&self, other: &Self) -> bool {
        self.most_left() >= other.most_right()
    }

    /// If `self` is within the left/right boundaries defined by `other`.
    pub fn within_horizontal_bounds_of(&self, other: &Self) -> bool {
        self.most_left() >= other.most_left() && self.most_right() <= other.most_right()
    }

    /// If `self` is within the top/bottom boundaries defined by `other`.
    pub fn within_vertical_bounds_of(&self, other: &Self) -> bool {
        self.most_top() >= other.most_top() && self.most_bottom() <= other.most_bottom()
    }

    /// If `self` is within the boundaries defined by `other`.
    pub fn within_bounds_of(&self, other: &Self) -> bool {
        self.within_horizontal_bounds_of(other) && self.within_vertical_bounds_of(other)
    }
}

#[derive(Debug, Clone)]
pub struct BoxModel {
    /// Content area quad.
    pub content: ElementQuad,
    /// Padding area quad.
    pub padding: ElementQuad,
    /// Border area quad.
    pub border: ElementQuad,
    /// Margin area quad.
    pub margin: ElementQuad,
    /// Width of the element.
    pub width: u32,
    /// Height of the element.
    pub height: u32,
}

impl BoxModel {
    /// Create a `Viewport` equal to the content-box, using a scale of 1.0
    pub fn content_viewport(&self) -> Viewport {
        Viewport {
            x: self.content.top_left.x,
            y: self.content.top_left.y,
            width: self.content.width(),
            height: self.content.height(),
            scale: 1.0,
        }
    }

    /// Create a `Viewport` equal to the padding-box, using a scale of 1.0
    pub fn padding_viewport(&self) -> Viewport {
        Viewport {
            x: self.padding.top_left.x,
            y: self.padding.top_left.y,
            width: self.padding.width(),
            height: self.padding.height(),
            scale: 1.0,
        }
    }

    /// Create a `Viewport` equal to the border-box, using a scale of 1.0
    pub fn border_viewport(&self) -> Viewport {
        Viewport {
            x: self.border.top_left.x,
            y: self.border.top_left.y,
            width: self.border.width(),
            height: self.border.height(),
            scale: 1.0,
        }
    }

    /// Create a `Viewport` equal to the margin-box, using a scale of 1.0
    pub fn margin_viewport(&self) -> Viewport {
        Viewport {
            x: self.margin.top_left.x,
            y: self.margin.top_left.y,
            width: self.margin.width(),
            height: self.margin.height(),
            scale: 1.0,
        }
    }
}

#[derive(Debug, Clone)]
pub struct BoundingBox {
    /// the x coordinate of the element in pixels.
    pub x: f64,
    /// the y coordinate of the element in pixels.
    pub y: f64,
    /// the width of the element in pixels.
    pub width: f64,
    /// the height of the element in pixels.
    pub height: f64,
}