Update OpenVR to v2.5.1, no longer using static bindings committed manually, workflow for building and testing on all platforms

[alexgeek]

No description provided.

[Tsuguri]

Questions:

• Will docs still be ok if we don't have bindings.rs file?
• How would user apply this workaround if bindings are always re-generated?
• What is wrong with having bindings.rs pre-generated in the repo?

[alexgeek]

Questions:

• Will docs still be ok if we don't have bindings.rs file?
• How would user apply this workaround if bindings are always re-generated?
• What is wrong with having bindings.rs pre-generated in the repo?

Thanks Tsu,

1. This I'm not sure about, but maybe it is ok since this sys crate is more internal? The other crate is expected to have a real public API.
2. From my testing, the workaround is no longer needed as it now generates the right mis-packed structures on mac/linux (assuming bindgen wasn't able to do this automatically before). I should remove this from the docs.
3. They are different for each platform so the prior method only worked for whatever platform it was built for. The alternative would be to build bindings for each platform, store them separately and use cfg to conditionally include them but that is quite a fiddly pipeline to setup.

R.e. 2, here is the bindings on linux

#[doc = " An event posted by the server to all running applications"]
#[repr(C, packed(4))]
#[derive(Copy, Clone)]
pub struct VREvent_t {
    pub eventType: u32,
    pub trackedDeviceIndex: TrackedDeviceIndex_t,
    pub eventAgeSeconds: f32,
    pub data: VREvent_Data_t,
}

and then Windows

#[doc = " An event posted by the server to all running applications"]
#[repr(C)]
#[derive(Copy, Clone)]
pub struct VREvent_t {
    pub eventType: u32,
    pub trackedDeviceIndex: TrackedDeviceIndex_t,
    pub eventAgeSeconds: f32,
    pub data: VREvent_Data_t,
}

The tests are passing on all platforms without modification now, they were not prior.

[Tsuguri]

I've tried to build locally and was not able to with rustc 1.81.0 (2024.09.04). Turns out there is rust-lang/rust#123743 some kind of bug with unsafe extern blocks which was resolved later. I think this may be due to updating bindgen by a lot of versions.

Doing that change would introduce MSRV of somewhere between 1.82 and 1.84 (this one worked for me). I don't know enough about this crate to decide whether it's ok to do that or not. Pinging @Ybalrid

Otherwise 👍🏻 from me.

[alexgeek]

I've tried to build locally and was not able to with rustc 1.81.0 (2024.09.04). Turns out there is rust-lang/rust#123743 some kind of bug with unsafe extern blocks which was resolved later. I think this may be due to updating bindgen by a lot of versions.

Doing that change would introduce MSRV of somewhere between 1.82 and 1.84 (this one worked for me). I don't know enough about this crate to decide whether it's ok to do that or not. Pinging @Ybalrid

Otherwise 👍🏻 from me.

Tempted to just put this in the Cargo.toml and call it day then:

''''
rust-version = "1.84.0"
''''

[alexgeek]

Will need to workaround this to package

cargo package
   Packaging openvr_sys v2.1.0 (D:\liv\rust-openvr-sys-og)
    Updating crates.io index
    Packaged 51 files, 1.9MiB (364.3KiB compressed)
   Verifying openvr_sys v2.1.0 (D:\liv\rust-openvr-sys-og)
   Compiling proc-macro2 v1.0.93
   Compiling windows_x86_64_msvc v0.52.6
   Compiling unicode-ident v1.0.16
   Compiling glob v0.3.2
   Compiling prettyplease v0.2.29
   Compiling libc v0.2.169
   Compiling memchr v2.7.4
   Compiling minimal-lexical v0.2.1
   Compiling shlex v1.3.0
   Compiling regex-syntax v0.8.5
   Compiling either v1.13.0
   Compiling bindgen v0.71.1
   Compiling log v0.4.25
   Compiling rustc-hash v2.1.0
   Compiling bitflags v2.8.0
   Compiling cc v1.2.10
   Compiling itertools v0.13.0
   Compiling clang-sys v1.8.1
   Compiling nom v7.1.3
   Compiling windows-targets v0.52.6
   Compiling libloading v0.8.6
   Compiling cmake v0.1.53
   Compiling regex-automata v0.4.9
   Compiling quote v1.0.38
   Compiling syn v2.0.96
   Compiling cexpr v0.6.0
   Compiling regex v1.11.1
   Compiling openvr_sys v2.1.0 (D:\liv\rust-openvr-sys-og\target\package\openvr_sys-2.1.0)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 14.31s
error: failed to verify package tarball

Caused by:
  Source directory was modified by build.rs during cargo publish. Build scripts should not modify anything outside of OUT_DIR.
  Added: D:\liv\rust-openvr-sys-og\target\package\openvr_sys-2.1.0\bindings.rs
        D:\liv\rust-openvr-sys-og\target\package\openvr_sys-2.1.0\openvr\bin
        D:\liv\rust-openvr-sys-og\target\package\openvr_sys-2.1.0\openvr\bin\win64
        D:\liv\rust-openvr-sys-og\target\package\openvr_sys-2.1.0\openvr\bin\win64\Debug
        D:\liv\rust-openvr-sys-og\target\package\openvr_sys-2.1.0\openvr\bin\win64\Debug\openvr_api64.lib

  To proceed despite this, pass the `--no-verify` flag.