Run examples in CI

.github/workflows/ci.yml

@@ -119,3 +119,17 @@ jobs:
         !contains(matrix.platform.target, 'redox') &&
         matrix.rust_version != '1.60.0'
       run: cargo $CMD test --verbose --target ${{ matrix.platform.target }} $OPTIONS --features serde,$FEATURES
+
+    # derived from  https://github.com/psychon/x11rb/blob/15153e514a4e3e4c116279f76ab1c3635abc05e5/.github/workflows/CI.yml#L141-L159
+    - name: Run examples
+      shell: bash
+      if: >
+        contains(matrix.platform.target, 'linux') &&
+        contains(matrix.platform.features, 'x11') && 
+        (contains(matrix.rust_version, 'stable') || contains(matrix.rust_version, 'nightly'))
+      run: |
+          for example in examples/*.rs; do
+            example=${example/examples\//}
+            example=${example/.rs/}
+            WINIT_EXAMPLE_TIMEOUT=1 xvfb-run -a cargo run --example "$example" || exit 1
+          done

examples/child_window.rs

@@ -1,3 +1,6 @@
+#[cfg(any(x11_platform, macos_platform, windows_platform))]
+include!("it_util/timeout.rs");
+
 #[cfg(any(x11_platform, macos_platform, windows_platform))]
 fn main() {
     use std::collections::HashMap;
@@ -39,6 +42,7 @@ fn main() {
         .with_inner_size(LogicalSize::new(640.0f32, 480.0f32))
         .build(&event_loop)
         .unwrap();
+    util::start_timeout_thread(&event_loop, ());
 
     println!("parent window: {parent_window:?})");
 
@@ -70,6 +74,9 @@ fn main() {
                 }
                 _ => (),
             }
+        } else if let Event::UserEvent(()) = event {
+            windows.clear();
+            *control_flow = ControlFlow::Exit;
         }
     })
 }

examples/control_flow.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use std::{thread, time};
 
 use simple_logger::SimpleLogger;
@@ -34,6 +36,8 @@ fn main() {
         .build(&event_loop)
         .unwrap();
 
+    util::start_timeout_thread(&event_loop, ());
+
     let mut mode = Mode::Wait;
     let mut request_redraw = false;
     let mut wait_cancelled = false;
@@ -108,6 +112,9 @@ fn main() {
                     }
                 };
             }
+            Event::UserEvent(()) => {
+                control_flow.set_exit();
+            }
             _ => (),
         }
     });

examples/cursor.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use simple_logger::SimpleLogger;
 use winit::{
     event::{ElementState, Event, KeyboardInput, WindowEvent},
@@ -10,6 +12,7 @@ use winit::{
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let window = WindowBuilder::new().build(&event_loop).unwrap();
     window.set_title("A fantastic window!");
@@ -46,6 +49,9 @@ fn main() {
             } => {
                 control_flow.set_exit();
             }
+            Event::UserEvent(()) => {
+                control_flow.set_exit();
+            }
             _ => (),
         }
     });

examples/cursor_grab.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use simple_logger::SimpleLogger;
 use winit::{
     event::{DeviceEvent, ElementState, Event, KeyboardInput, ModifiersState, WindowEvent},
@@ -10,6 +12,7 @@ use winit::{
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let window = WindowBuilder::new()
         .with_title("Super Cursor Grab'n'Hide Simulator 9000")
@@ -64,6 +67,7 @@ fn main() {
                 },
                 _ => (),
             },
+            Event::UserEvent(()) => control_flow.set_exit(),
             _ => (),
         }
     });

examples/custom_events.rs

@@ -1,5 +1,8 @@
 #![allow(clippy::single_match)]
 
+#[cfg(not(wasm_platform))]
+include!("it_util/timeout.rs");
+
 #[cfg(not(wasm_platform))]
 fn main() {
     use simple_logger::SimpleLogger;
@@ -12,10 +15,12 @@ fn main() {
     #[derive(Debug, Clone, Copy)]
     enum CustomEvent {
         Timer,
+        Timeout,
     }
 
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoopBuilder::<CustomEvent>::with_user_event().build();
+    util::start_timeout_thread(&event_loop, CustomEvent::Timeout);
 
     let _window = WindowBuilder::new()
         .with_title("A fantastic window!")
@@ -39,7 +44,11 @@ fn main() {
         control_flow.set_wait();
 
         match event {
-            Event::UserEvent(event) => println!("user event: {event:?}"),
+            Event::UserEvent(CustomEvent::Timer) => println!("user event: {event:?}"),
+            Event::UserEvent(CustomEvent::Timeout) => {
+                println!("user event: {event:?}");
+                control_flow.set_exit();
+            }
             Event::WindowEvent {
                 event: WindowEvent::CloseRequested,
                 ..

examples/drag_window.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use simple_logger::SimpleLogger;
 use winit::{
     event::{
@@ -12,6 +14,7 @@ use winit::{
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let window_1 = WindowBuilder::new().build(&event_loop).unwrap();
     let window_2 = WindowBuilder::new().build(&event_loop).unwrap();
@@ -59,6 +62,7 @@ fn main() {
             }
             _ => (),
         },
+        Event::UserEvent(()) => control_flow.set_exit(),
         _ => (),
     });
 }

examples/fullscreen.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use simple_logger::SimpleLogger;
 use winit::event::{ElementState, Event, KeyboardInput, VirtualKeyCode, WindowEvent};
 use winit::event_loop::EventLoop;
@@ -8,6 +10,7 @@ use winit::window::{Fullscreen, WindowBuilder};
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let mut decorations = true;
     let mut minimized = false;
@@ -107,6 +110,7 @@ fn main() {
                 },
                 _ => (),
             },
+            Event::UserEvent(()) => control_flow.set_exit(),
             _ => {}
         }
     });

examples/handling_close.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use simple_logger::SimpleLogger;
 use winit::{
     event::{Event, KeyboardInput, WindowEvent},
@@ -10,6 +12,7 @@ use winit::{
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let _window = WindowBuilder::new()
         .with_title("Your faithful window")
@@ -80,6 +83,7 @@ fn main() {
                     _ => (),
                 }
             }
+            Event::UserEvent(()) => control_flow.set_exit(),
             _ => (),
         }
     });

examples/ime.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use log::LevelFilter;
 use simple_logger::SimpleLogger;
 use winit::{
@@ -21,6 +23,7 @@ fn main() {
     println!("Press F3 to cycle through IME purposes.");
 
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let window = WindowBuilder::new()
         .with_inner_size(winit::dpi::LogicalSize::new(256f64, 128f64))
@@ -106,6 +109,9 @@ fn main() {
                     println!("\nIME purpose: {ime_purpose:?}\n");
                 }
             }
+            Event::UserEvent(()) => {
+                control_flow.set_exit();
+            }
             _ => (),
         }
     });

examples/it_util/timeout.rs

@@ -0,0 +1,42 @@
+// Spawns a timeout thread that will close the event loop after one second.
+
+#[cfg(not(wasm_platform))]
+mod util {
+    use std::env;
+    use std::thread;
+    use winit::event_loop::EventLoop;
+
+    pub(super) fn start_timeout_thread<T: Send + 'static>(event_loop: &EventLoop<T>, msg_to_send: T) {
+        // If the WINIT_EXAMPLE_TIMEOUT environment variable is set, get the number of seconds
+        // to wait before closing the window.
+        let secs = match env::var("WINIT_EXAMPLE_TIMEOUT")
+            .ok()
+            .and_then(|s| s.parse::<u64>().ok())
+        {
+            Some(secs) => secs,
+            None => return,
+        };
+
+        // Spawn a thread that will close the window after `secs` seconds.
+        thread::Builder::new()
+            .name("winit example timeout".to_string())
+            .spawn({
+                let proxy = event_loop.create_proxy();
+                move || {
+                    thread::sleep(std::time::Duration::from_secs(secs));
+                    println!("Closing window due to timeout");
+                    proxy.send_event(msg_to_send).unwrap_or_else(|_| panic!("Failed to send event to event loop"));
+                }
+            })
+            .expect("failed to spawn timeout thread");
+    }
+}
+
+#[cfg(wasm_platform)]
+mod util {
+    use winit::event_loop::EventLoop;
+
+    pub(super) fn start_timeout_thread<T: Send + 'static>(_event_loop: &EventLoop<T>, _msg_to_send: T) {
+        // Not supported on web.
+    }
+}

examples/mouse_wheel.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use simple_logger::SimpleLogger;
 use winit::{
     event::{Event, WindowEvent},
@@ -10,6 +12,7 @@ use winit::{
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let window = WindowBuilder::new()
         .with_title("Mouse Wheel events")
@@ -56,6 +59,9 @@ In other words, the deltas indicate the direction in which to move the content (
                 },
                 _ => (),
             },
+            Event::UserEvent(()) => {
+                control_flow.set_exit();
+            }
             _ => (),
         }
     });

examples/multithreaded.rs

@@ -1,5 +1,8 @@
 #![allow(clippy::single_match)]
 
+#[cfg(not(wasm_platform))]
+include!("it_util/timeout.rs");
+
 #[cfg(not(wasm_platform))]
 fn main() {
     use std::{collections::HashMap, sync::mpsc, thread, time::Duration};
@@ -17,6 +20,8 @@ fn main() {
 
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
+
     let mut window_senders = HashMap::with_capacity(WINDOW_COUNT);
     for _ in 0..WINDOW_COUNT {
         let window = WindowBuilder::new()
@@ -188,6 +193,10 @@ fn main() {
                     }
                 }
             },
+            Event::UserEvent(()) => {
+                window_senders.clear();
+                control_flow.set_exit();
+            }
             _ => {}
         }
     })

examples/multiwindow.rs

@@ -1,5 +1,7 @@
 #![allow(clippy::single_match)]
 
+include!("it_util/timeout.rs");
+
 use std::collections::HashMap;
 
 use simple_logger::SimpleLogger;
@@ -12,6 +14,7 @@ use winit::{
 fn main() {
     SimpleLogger::new().init().unwrap();
     let event_loop = EventLoop::new();
+    util::start_timeout_thread(&event_loop, ());
 
     let mut windows = HashMap::new();
     for _ in 0..3 {
@@ -55,6 +58,9 @@ fn main() {
                     _ => (),
                 }
             }
+            Event::UserEvent(()) => {
+                control_flow.set_exit();
+            }
             _ => (),
         }
     })