Add: Support #[deprecated] attribute #860

sevenc-nanashi · 2023-07-23T08:05:57Z

(My mother language is not English, so I may say some inappropriate things.)
This PR adds support of #[deprecated] attribute like must_use.
It supports:

#[deprecate],
#[deprecate = "note"],
#[deprecate(note = "note")]
for:
function
enum
struct

This PR closes #408. Also, I'm new to Rust, so I should have written some ineffective code. I'd like some reviews. Thank you.

sevenc-nanashi · 2023-07-23T08:06:12Z

Cargo.toml

@@ -26,7 +26,7 @@ serde = { version = "1.0.103", default-features = false, features = ["derive"] }
 serde_json = "1.0"
 tempfile = "3"
 toml = "0.5"
-proc-macro2 = "1"
+proc-macro2 = "1.0.60"


src/bindgen/utilities.rs

emilio

Looks generally reasonable, thanks. Some comments below

src/bindgen/ir/annotation.rs

emilio · 2023-08-25T15:16:11Z

src/bindgen/ir/annotation.rs

+            Some(note)
+        } else if attrs.has_attr_word("deprecated") {
+            Some("".to_string())
+        } else if let Some(attr) = attrs.iter().find(|attr| {


Is this code-path tested?

It should be.

src/bindgen/ir/enumeration.rs

src/bindgen/utilities.rs

sevenc-nanashi · 2023-08-25T16:04:57Z

src/bindgen/ir/annotation.rs

        if config.language == Language::Cython {
            return None;
        }

        self.deprecated.clone()
    }

+    pub(crate) fn format_deprecated_note(


I have no idea around where to put these utilities.

This doesn't use self, so at the very least should be a static function right?

sevenc-nanashi · 2023-08-25T16:05:53Z

Applied review. Could you review again please?

src/bindgen/ir/annotation.rs

src/bindgen/utilities.rs

src/bindgen/ir/function.rs

Co-Authored-By: emilio <emilio@users.noreply.github.com>

sevenc-nanashi · 2023-08-27T07:30:44Z

This one looks great, thanks! But rather than aborting parsing the item when we fail to parse #[deprecated], I'd rather make this return an Option, and return None for the error cases (maybe warn! ing if you want).

(I couldn't reply somehow, so replying here): Thanks, the function returns Option<String> and warn! for error cases..

emilio · 2023-09-04T18:20:49Z

I rebased your changes since we had some test renaming recently, and cleaned-up a bit. Thanks for the patch! I realized I left a pending comment below, feel free to ignore.

* Fix swapping of `>>=` and `<<=` in constants. * Add support for #[deprecated] (#860). * Built-in support for bitflags 2.0. * Support for "C-unwind" ABI. * Generate bindings for non-public extern items if they are #[no_mangle].

Updates the requirements on [cbindgen](https://github.com/mozilla/cbindgen) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mozilla/cbindgen/releases">cbindgen's releases</a>.</em></p> <blockquote> <h2>0.26.0</h2> <ul> <li>Fix swapping of <code>>>=</code> and <code><<=</code> in constants.</li> <li>Add support for #[deprecated] (<a href="https://redirect.github.com/mozilla/cbindgen/issues/860">#860</a>).</li> <li>Built-in support for bitflags 2.0.</li> <li>Support for "C-unwind" ABI.</li> <li>Generate bindings for non-public extern items if they are #[no_mangle].</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/mozilla/cbindgen/blob/master/CHANGES">cbindgen's changelog</a>.</em></p> <blockquote> <h1>0.26.0</h1> <pre><code> * Fix swapping of `>>=` and `<<=` in constants. * Add support for #[deprecated] ([#860](mozilla/cbindgen#860)). * Built-in support for bitflags 2.0. * Support for "C-unwind" ABI. * Generate bindings for non-public extern items if they are #[no_mangle]. </code></pre> <h2>0.25.0</h2> <pre><code> * Re-release of yanked 0.24.6 as a major release * Update MSRV to 1.57 * Support variadic arguments (`...`) ([#805](mozilla/cbindgen#805)) * Add --depfile option ([#820](mozilla/cbindgen#820)) * Breaking changes: The `Config` struct now has a private member. </code></pre> <h2>0.24.6 (YANKED: depfile option was breaking, see <a href="https://redirect.github.com/mozilla/cbindgen/issues/841">#841</a>)</h2> <pre><code> * Update MSRV to 1.57 * Support variadic arguments (`...`) ([#805](mozilla/cbindgen#805)) * Add --depfile option ([#820](mozilla/cbindgen#820)) </code></pre> <h2>0.24.5</h2> <pre><code> * Don't enforce tempfile version. </code></pre> <h2>0.24.4</h2> <pre><code> * Move expand infinite recursion fix ([#799](mozilla/cbindgen#799)) * Add with_cpp_compat to the builder ([#796](mozilla/cbindgen#796)) * Handle never type in return position consistently ([#780](mozilla/cbindgen#780)) * Fix warnings ([#816](mozilla/cbindgen#816), [#819](mozilla/cbindgen#819)) * Updated documentation ([#788](mozilla/cbindgen#788), [#791](mozilla/cbindgen#791), [#792](mozilla/cbindgen#792), [#810](mozilla/cbindgen#810), [#823](mozilla/cbindgen#823)) </code></pre> <h2>0.24.3</h2> <pre><code> * Make struct expressions correctly generated through typedefs ([#768](mozilla/cbindgen#768)). </code></pre> <h2>0.24.2</h2> <pre><code> * Make bitfield operators use explicit constructors. </code></pre> <h2>0.24.1</h2> <pre><code> * Add support for unary negation ([#765](mozilla/cbindgen#765)). * Make more bitfield operators constexpr ([#765](mozilla/cbindgen#765)). </code></pre> <h2>0.24.0</h2> <pre><code> * Basic const generic support ([#759](mozilla/cbindgen#759), [#760](mozilla/cbindgen#760) [#762](mozilla/cbindgen#762)). </code></pre>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mozilla/cbindgen/commit/703b53c06f9fe2dbc0193d67626558cfa84a0f62"><code>703b53c</code></a> v0.26.0</li> <li><a href="https://github.com/mozilla/cbindgen/commit/56f0febc9b5cc7ee957912d55b1fdee67f34d766"><code>56f0feb</code></a> Update MSRV in Readme</li> <li><a href="https://github.com/mozilla/cbindgen/commit/9b4a14958ea6ce2a61accb9cdbad84cfca9c3013"><code>9b4a149</code></a> Add support for out-of-line bitfields declarations</li> <li><a href="https://github.com/mozilla/cbindgen/commit/35f2e44ef2792d1c2e9e97f8ccf4458b79ae88f2"><code>35f2e44</code></a> Update URLs</li> <li><a href="https://github.com/mozilla/cbindgen/commit/85eb0f4436e90d479f5d041b98f160ce2e66eeea"><code>85eb0f4</code></a> Bump clippy msrv to 1.64</li> <li><a href="https://github.com/mozilla/cbindgen/commit/43af1ebe6e4d2bb9ec90167616a3d88bf34c7c0b"><code>43af1eb</code></a> Handle bitflags bits method calls</li> <li><a href="https://github.com/mozilla/cbindgen/commit/f72e44715697981b9317b7f0688216990e60346d"><code>f72e447</code></a> CHANGES: Note #[deprecated] support.</li> <li><a href="https://github.com/mozilla/cbindgen/commit/14730702306533c2805c9dd4a6846e762a4bbcca"><code>1473070</code></a> utilities: annotation: Clean-up deprecated parsing and getter.</li> <li><a href="https://github.com/mozilla/cbindgen/commit/0fb5d07ae4ede7d3fcf91c47bcfa29090ce0a8b9"><code>0fb5d07</code></a> Add support for #[deprecated].</li> <li><a href="https://github.com/mozilla/cbindgen/commit/d8355da4664f68d399631f2f215cbf991c121d2f"><code>d8355da</code></a> Support "C-unwind" ABI</li> <li>Additional commits viewable in <a href="https://github.com/mozilla/cbindgen/compare/v0.25.0...0.26.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

sevenc-nanashi added 10 commits July 23, 2023 07:31

WIP:

f86d749

Add: Add deprecated

87561a4

Fix: Fix it generates invalid python code

e001222

Fix: Support quotes

d75abe9

Change: Move creation of [[deprecated]]

19845d8

Add: Support enum

608a31e

Change: Add deprecate if c23

ff164fb

Update: Update test

6c29ff7

Add: Add test exceptation

5733bf8

Code: Use out.write

b5ae00e

sevenc-nanashi commented Jul 23, 2023

View reviewed changes

Fix: Fix condition

a9587bb

sevenc-nanashi marked this pull request as draft July 23, 2023 22:03

sevenc-nanashi added 2 commits July 28, 2023 15:37

(WIP) Change: make it like must_use

fbe51c6

Change: make it like must_use

6bfb3ff

sevenc-nanashi marked this pull request as ready for review July 28, 2023 07:23

sevenc-nanashi added 2 commits July 28, 2023 16:28

Fix: Fix formatting

31fff88

Update: Update template.toml

a439a3a

emilio requested changes Aug 25, 2023

View reviewed changes

sevenc-nanashi added 3 commits August 26, 2023 00:38

Change: deprecated -> deprecated_node

bb39e3a

Change: move finding deperecation node to outer side of a function

1a3f566

Refactor: Move to a new function to avoid copy-pasting

81bf4ca

sevenc-nanashi commented Aug 25, 2023

View reviewed changes

sevenc-nanashi requested a review from emilio August 25, 2023 16:05

emilio requested changes Aug 25, 2023

View reviewed changes

src/bindgen/ir/annotation.rs Outdated Show resolved Hide resolved

src/bindgen/ir/annotation.rs Outdated Show resolved Hide resolved

src/bindgen/utilities.rs Outdated Show resolved Hide resolved

src/bindgen/ir/function.rs Outdated Show resolved Hide resolved

sevenc-nanashi and others added 3 commits August 27, 2023 16:20

Change: Option<String> -> Option<&str>

50b6171

Co-Authored-By: emilio <emilio@users.noreply.github.com>

Change: Result<Option<String>, String> -> Option<String> and warn!

05d7035

Change: Use helper

19db2a4

Merge: master -> add/deprecated

d13bb58

sevenc-nanashi requested a review from emilio August 27, 2023 07:31

sevenc-nanashi added 3 commits August 27, 2023 22:23

Change: Use helper

5b119db

Change: Remove let-else

507eaa5

Fix: Use Some(

5809afc

emilio mentioned this pull request Sep 4, 2023

#[deprecated] #875

Closed

emilio added a commit that referenced this pull request Sep 4, 2023

CHANGES: Note #[deprecated] support (#860).

38a4cfb

emilio closed this in 0fb5d07 Sep 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add: Support #[deprecated] attribute #860

Add: Support #[deprecated] attribute #860

sevenc-nanashi commented Jul 23, 2023 •

edited

sevenc-nanashi Jul 23, 2023

emilio left a comment

emilio Aug 25, 2023

sevenc-nanashi Aug 25, 2023

sevenc-nanashi Aug 25, 2023

emilio Sep 4, 2023

sevenc-nanashi commented Aug 25, 2023 •

edited

sevenc-nanashi commented Aug 27, 2023

emilio commented Sep 4, 2023

Add: Support #[deprecated] attribute #860

Add: Support #[deprecated] attribute #860

Conversation

sevenc-nanashi commented Jul 23, 2023 • edited

sevenc-nanashi Jul 23, 2023

Choose a reason for hiding this comment

emilio left a comment

Choose a reason for hiding this comment

emilio Aug 25, 2023

Choose a reason for hiding this comment

sevenc-nanashi Aug 25, 2023

Choose a reason for hiding this comment

sevenc-nanashi Aug 25, 2023

Choose a reason for hiding this comment

emilio Sep 4, 2023

Choose a reason for hiding this comment

sevenc-nanashi commented Aug 25, 2023 • edited

sevenc-nanashi commented Aug 27, 2023

emilio commented Sep 4, 2023

sevenc-nanashi commented Jul 23, 2023 •

edited

sevenc-nanashi commented Aug 25, 2023 •

edited