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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
//! Contains struct and enum declarations for
//! structs defined by wlc.

use std::fmt;
use std::cmp;

/// Log level to pass into wlc logging
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum LogType {
    /// Info log type
    Info,
    /// Warn log type
    Warn,
    /// Error log type
    Error,
    /// Wayland logs
    Wayland
}

/// Type of backend that a window is being composited in
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum BackendType {
    /// Backend type is unknown
    None,
    /// Standard wayland client
    DRM,
    /// wayland-x11 client
    X11
}

bitflags! {
    /// Flags describing wayland events
    #[repr(C)]
    pub flags EventBit: u32 {
        /// Event can be read
        const EVENT_READABLE = 1,
        /// Event can be written
        const EVENT_WRITEABLE = 2,
        /// Event is hung up (?)
        const EVENT_HANGUP = 4,
        /// Event is in error
        const EVENT_ERROR = 8
    }
}

bitflags! {
    /// How window is being viewed
    #[repr(C)]
    pub flags ViewState: u32 {
        /// Window maximized
        const VIEW_MAXIMIZED = 1,
        /// Window fullscreen
        const VIEW_FULLSCREEN = 2,
        /// Window resizing
        const VIEW_RESIZING = 4,
        /// Window moving
        const VIEW_MOVING = 8,
        /// Window activated
        const VIEW_ACTIVATED = 16
    }
}

bitflags! {
    /// Viewtype - like x11 flags
    #[repr(C)]
    pub flags ViewType: u32 {
        /// Override redirect (X11)
        const VIEW_BIT_OVERRIDE_REDIRECT = 1,
        /// Tooltips (X11)
        const VIEW_BIT_UNMANAGED = 2,
        /// Splash Screens (X11)
        const VIEW_BIT_SPLASH = 4,
        /// Modal Windows (X11)
        const VIEW_BIT_MODAL = 8,
        /// xdg-shell, wl-shell popups
        const VIEW_BIT_POPUP = 16
    }
}

bitflags! {
    /// Which edge is being used to resize a window.
    #[repr(C)]
    pub flags ResizeEdge: u32 {
        /// No edge
        const EDGE_NONE = 0,
        /// Top edge
        const RESIZE_TOP = 1,
        /// Bottom edge
        const RESIZE_BOTTOM = 2,
        /// Left edge
        const RESIZE_LEFT = 4,
        /// Top left edge
        const RESIZE_TOPLEFT = 5,
        /// Bottom left edge
        const RESIZE_BOTTOMLEFT = 6,
        /// Right edge
        const RESIZE_RIGHT = 8,
        /// Top right edge
        const RESIZE_TOPRIGHT = 9,
        /// Bottom right edge
        const RESIZE_BOTTOMRIGHT = 10
    }
}

bitflags! {
    /// Which view property is being updated
    #[repr(C)]
    pub flags ViewPropertyType: u32 {
        /// View title is being updated
        const PROPERTY_TITLE = 0,
        /// View class is being updated
        const PROPRETY_CLASS = 1,
        /// View app id is being updated
        const PROPERTY_APP_ID = 2,
        /// PID of the view is being updated
        const PROPERTY_PID = 4
    }
}

bitflags! {
    /// Represents which keyboard meta keys are being pressed.
    #[repr(C)]
    pub flags KeyMod: u32 {
        /// No modifiers
        const MOD_NONE = 0,
        /// Shift
        const MOD_SHIFT = 1,
        /// Caps lock
        const MOD_CAPS = 2,
        /// Control
        const MOD_CTRL = 4,
        /// Alt
        const MOD_ALT = 8,
        /// Mod2
        const MOD_MOD2 = 16,
        /// Mod3
        const MOD_MOD3 = 32,
        /// Mod4/logo
        const MOD_MOD4 = 64,
        /// 5Mod5Me
        const MOD_MOD5 = 128
    }
}

bitflags! {
    /// "LEDs" or active key-locks.
    /// i.e. caps lock, scroll lock
    #[repr(C)]
    pub flags KeyboardLed: u32 {
        /// Num lock is pressed
        const NUM_LOCK = 1,
        /// Caps lock is pressed
        const CAPS_LOCK = 2,
        /// Original typo of SCROLL_LOCK
        ///
        /// # Deprecated
        /// Please use SCROLL_LOCK instead.
        const SCROL_LLOCK = 4,
        /// Scroll lock key is being pressed.
        const SCROLL_LOCK = 4
    }
}

bitflags! {
    #[repr(C)]
    pub flags PositionerAnchorBit: u32 {
        const WLC_BIT_ANCHOR_NONE = 0,
        const WLC_BIT_ANCHOR_TOP = 1<<0,
        const WLC_BIT_ANCHOR_BOTTOM = 1<<1,
        const WLC_BIT_ANCHOR_LEFT = 1<<2,
        const WLC_BIT_ANCHOR_RIGHT = 1<<3
    }
}

bitflags! {
    #[repr(C)]
    pub flags PositionerGravityBit: u32 {
        const WLC_BIT_GRAVITY_NONE = 0,
        const WLC_BIT_GRAVITY_TOP = 1<<0,
        const WLC_BIT_GRAVITY_BOTTOM = 1<<1,
        const WLC_BIT_GRAVITY_LEFT = 1<<2,
        const WLC_BIT_GRAVITY_RIGHT = 1<<3

    }
}

bitflags! {
    #[repr(C)]
    pub flags PositionerConstraintAdjustmentBits: u32 {
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_NONE = 0,
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_SLIDE_X = 1<<0,
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_SLIDE_Y = 1<<1,
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_FLIP_X = 1<<2,
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_FLIP_Y = 1<<3,
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_RESIZE_X = 1<<4,
        const WLC_BIT_CONSTRAINT_ADJUSTMENT_RESIZE_Y = 1<<5
    }
}

/// Represents a key state in key events
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum KeyState {
    /// Key is being pressed
    Released = 0,
    /// Key is being released
    Pressed = 1
}

/// Represents a button state in button events
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum ButtonState {
    /// Button is being pressed
    Released = 0,
    /// Button is being released
    Pressed = 1
}

/// Which axis of the scroll wheel is being used
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum ScrollAxis {
    /// No axes
    None = 0,
    /// Vertical scroll
    Vertical = 1,
    /// Horizontal scroll
    Horizontal = 2,
    /// Both scrolls
    Both = 3
}

/// Touch type in touch interface handler
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum TouchType {
    /// Touch down
    Down,
    /// Touch up
    Up,
    /// Touch motion
    Motion,
    /// Touch frame
    Frame,
    /// Touch cancelled
    Cancel
}

/// State of keyoard modifiers.
/// i.e. control key, caps lock on
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct KeyboardModifiers {
    /// Which "lock" keys are being pressed
    pub leds: KeyboardLed,
    /// Which control/meta keys are being pressed
    pub mods: KeyMod
}

/// Represents the location of a view.
#[repr(C)]
#[derive(Debug, Eq, PartialEq, Copy, Clone, Hash)]
pub struct Point {
    /// x coordinate
    pub x: i32,
    /// y coordinate
    pub y: i32
}

impl Point {
    /// The point defined as (0, 0).
    pub fn origin() -> Point {
        Point { x: 0, y: 0 }
    }

    /// Create a new point from the given x and y coordinates.
    pub fn new(x: i32, y: i32) -> Point {
        Point { x: x, y: y }
    }

    /// Creates a new point with an x and y which are the smallest of the two
    /// points.
    ///
    /// # Examples:
    /// ```rust
    /// # use rustwlc::Point;
    /// let a = Point::new(0i32, 12i32);
    /// let b = Point::new(12i32, 0i32);
    ///
    /// assert_eq!(Point::from_min_coords(a, b), Point::new(0, 0));
    /// ```
    pub fn from_min_coords(a: Point, b: Point) -> Point {
        Point::new(cmp::min(a.x, b.x), cmp::min(a.y, b.y))
    }

    /// Creates a new point with an x and y which are the largest of the two
    /// points.
    ///
    /// # Examples:
    /// ```rust
    /// # use rustwlc::Point;
    /// let a = Point::new(0i32, 12i32);
    /// let b = Point::new(12i32, 0i32);
    ///
    /// assert_eq!(Point::from_max_coords(a, b), Point::new(12i32, 12i32));
    /// ```
    pub fn from_max_coords(a: Point, b: Point) -> Point {
        Point::new(cmp::max(a.x, b.x), cmp::max(a.y, b.y))
    }
}

impl fmt::Display for Point {
    fn fmt(&self, format: &mut fmt::Formatter) -> fmt::Result {
        write!(format, "({}, {})", self.x, self.y)
    }
}

/// Represents the height and width of a view.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct Size {
    /// Width
    pub w: u32,
    /// Height
    pub h: u32
}

impl Size {
    /// A size with zero width and height.
    pub fn zero() -> Size {
        Size { w: 0, h: 0 }
    }

    /// Create a new Size from the given height and width.
    pub fn new(w: u32, h: u32) -> Size {
        Size { w: w, h: h }
    }

    /// Creates a new size with a height and width of the smallest of the two
    /// sizes.
    ///
    /// # Examples:
    /// ```rust
    /// # use rustwlc::Size;
    /// let a = Size::new(0u32, 12u32);
    /// let b = Size::new(12u32, 0u32);
    ///
    /// assert_eq!(Size::from_min_dimensions(a, b), Size::new(0u32, 0u32));
    /// ```
    pub fn from_min_dimensions(a: Size, b: Size) -> Size {
        Size::new(cmp::min(a.h, b.h), cmp::min(a.w, b.w))
    }

    /// Creates a new size with a height and width of the smallest of the two
    /// sizes.
    ///
    /// # Examples:
    /// ```rust
    /// # use rustwlc::Size;
    /// let a = Size::new(0u32, 12u32);
    /// let b = Size::new(12u32, 0u32);
    ///
    /// assert_eq!(Size::from_max_dimensions(a, b), Size::new(12u32, 12u32));
    /// ```
    pub fn from_max_dimensions(a: Size, b: Size) -> Size {
        Size::new(cmp::max(a.h, b.h), cmp::max(a.w, b.w))
    }
}

impl fmt::Display for Size {
    fn fmt(&self, format: &mut fmt::Formatter) -> fmt::Result {
        write!(format, "{} x {}", self.w, self.h)
    }
}

/// Represents the location and size of a view
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct Geometry {
    /// The location of the object
    pub origin: Point,
    /// The size of the object
    pub size: Size
}

impl Geometry {
    /// Creates a geometry with zero size at the origin.
    pub fn zero() -> Geometry {
        Geometry { origin: Point::origin(), size: Size::zero() }
    }

    /// Creates a new geometry with the given size and location.
    pub fn new(origin: Point, size: Size) -> Geometry {
        Geometry { origin: origin, size: size }
    }

    /// Determines if this geometry contains a point.
    ///
    /// If the point's coordinates are less than or equal to this geometry's
    /// dimensions plus its size.
    pub fn contains_point(self, point: Point) -> bool {
        point.x <= self.origin.x + self.size.w as i32 &&
            point.y <= self.origin.y + self.size.h as i32
    }

    /// Determines if this geometry contains another.
    ///
    /// If the other geometry's borders could be fully contained (less than
    /// or equal to) within self.
    pub fn contains_geometry(self, other: Geometry) -> bool {
        self.origin.x <= other.origin.x
            && self.origin.y <= other.origin.y
            && self.origin.x + self.size.w as i32
                >= other.origin.x + other.size.w as i32
            && self.origin.y + self.size.h as i32
                >= other.origin.y + other.size.h as i32
    }
}

impl fmt::Display for Geometry {
    fn fmt(&self, format: &mut fmt::Formatter) -> fmt::Result {
        write!(format, "[{} at {}]", self.size, self.origin)
    }
}

/// Not currently supporting libinput
#[repr(C)]
pub struct LibinputDevice;