Detect unused `bindgen`/`riddle` filters #2634

kennykerr · 2023-08-28T17:38:06Z

As an example:

> riddle.exe -i windows.winmd -o output.rs -f Windows.Foundation.Rect WIndows !Windows.Fondation
error: unused filters
  Windows.Fondation
  WIndows

Fixes: #2630

ChrisDenton

Looks great to me! I also tried it on the rustc riddle PR and it showed up things that had been moved or removed. I'll update that when I have a mo.

This PR also has a few misc cleanups? Not complaining mind you.

riverar · 2023-08-28T19:04:44Z

crates/libs/bindgen/src/winmd/verify.rs

+            message.push_str(&format!("\n  {unused}"));
+        }
+
+        return Err(crate::Error::new(&message));


Surfacing these as errors versus warnings may make third-party crate maintenance harder than it needs to be. I can see a scenario where folks will want to add a preemptive filter for, say, X.Y.Z.Preview namespaces when they appear/don't appear during a dev cycle. Or simply don't care if they over-specify the filter list.

No change needed right now though, we can take the "lets see what happens" approach.

Personally, I do prefer the error because I'd like the filter list to reflect what goes into the generated bindings (no more, no less). But I accept that other people may have other preferences.

kennykerr · 2023-08-28T19:26:41Z

This PR also has a few misc cleanups?

Only some dead/commented code that I happened upon as well as hardening the tests to ensure that the filtering was working correctly.

kennykerr · 2023-08-28T19:28:05Z

Thanks for checking! I'll leave it like this for now and we can reevaluate in future as needed.

chore(deps): update rust crate windows-sys to 0.52 [![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [windows-sys](https://togithub.com/microsoft/windows-rs) | workspace.dependencies | minor | `0.48` -> `0.52` | --- ### Release Notes <details> <summary>microsoft/windows-rs (windows-sys)</summary> ### [`v0.52.0`](https://togithub.com/microsoft/windows-rs/releases/tag/0.52.0) [Compare Source](https://togithub.com/microsoft/windows-rs/compare/0.48.0...0.52.0) This release includes updates to all crates. This includes the first update to the `windows-sys` crate in 8 months. It also includes the first published version of the [riddle](https://crates.io/crates/riddle) tool and the [windows-version](https://crates.io/crates/windows-version) crate. #### What's Changed - Simplify issue templates by [`@riverar](https://togithub.com/riverar)` in [microsoft/windows-rs#2621 - Switch all crates to Rust edition 2021 by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2620 - Correct workflow trigger ignore paths by [`@riverar](https://togithub.com/riverar)` in [microsoft/windows-rs#2622 - Detect unused `bindgen`/`riddle` filters by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2634 - Fix `BOOLEAN` parameter binding by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2635 - Provide individual crate readme files by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2645 - Tweak Win32 error code conversion to handle `HRESULT` input by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2646 - Remove support for the defunct `StaticLibrary` attribute by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2647 - Derive `PartialEq`, `Eq`, `Debug`, `Clone` for interfaces by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2651 - Internal `bindgen` refactoring by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2654 - Disable signature transformation for `NTSTATUS` by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2658 - Unhide `query` method on `ComInterface` trait by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2659 - Harden `QueryInterface` implementation by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2660 - Mask non-reproducible linker artifacts in libs by [`@riverar](https://togithub.com/riverar)` in [microsoft/windows-rs#2661 - Slim doc generation by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2671 - Update SDK and WDK metadata by [`@riverar](https://togithub.com/riverar)` in [microsoft/windows-rs#2664 - Add feature documentation quotes by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2675 - Add `docs` feature by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2676 - Simplify metadata reader by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2682 - Add bindgen config option to disable generating inner attributes by [`@dpaoliello](https://togithub.com/dpaoliello)` in [microsoft/windows-rs#2683 - Simplify metadata filtering by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2684 - Simplify code generation by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2686 - Fix link from docs.rs to full API documentation by [`@ChrisDenton](https://togithub.com/ChrisDenton)` in [microsoft/windows-rs#2688 - Optimize tick trimming by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2689 - Small bindgen refactor and tools refresh by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2695 - Document `implement` and `interface` macros by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2696 - Perform checked integral type conversions for APIs by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2699 - Add `windows-version` crate by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2702 - Add crate-specific readme files by [`@kennykerr](https://togithub.com/kennykerr)` in [microsoft/windows-rs#2703 #### New Contributors - [`@dpaoliello](https://togithub.com/dpaoliello)` made their first contribution in [microsoft/windows-rs#2683 **Full Changelog**: microsoft/windows-rs@0.48.5...0.52.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 5am on the first day of the month" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/rust-lang/cargo).

kennykerr added 2 commits August 28, 2023 12:32

unused

543de4d

test

ebf1b8b

kennykerr requested review from riverar and ChrisDenton August 28, 2023 18:01

test

d95e30f

kennykerr changed the title ~~Detect unused bindgen filters~~ Detect unused bindgen/riddle filters Aug 28, 2023

ChrisDenton approved these changes Aug 28, 2023

View reviewed changes

riverar approved these changes Aug 28, 2023

View reviewed changes

kennykerr merged commit 0b86626 into master Aug 28, 2023
47 checks passed

kennykerr deleted the unused branch August 28, 2023 19:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Detect unused `bindgen`/`riddle` filters #2634

Detect unused `bindgen`/`riddle` filters #2634

kennykerr commented Aug 28, 2023 •

edited

ChrisDenton left a comment

riverar Aug 28, 2023 •

edited

ChrisDenton Aug 28, 2023

kennykerr commented Aug 28, 2023

kennykerr commented Aug 28, 2023

Detect unused bindgen/riddle filters #2634

Detect unused bindgen/riddle filters #2634

Conversation

kennykerr commented Aug 28, 2023 • edited

ChrisDenton left a comment

Choose a reason for hiding this comment

riverar Aug 28, 2023 • edited

Choose a reason for hiding this comment

ChrisDenton Aug 28, 2023

Choose a reason for hiding this comment

kennykerr commented Aug 28, 2023

kennykerr commented Aug 28, 2023

Detect unused `bindgen`/`riddle` filters #2634

Detect unused `bindgen`/`riddle` filters #2634

kennykerr commented Aug 28, 2023 •

edited

riverar Aug 28, 2023 •

edited