Add option for sorting of function names #466

systec-ad · 2020-01-26T12:45:53Z

Closes #461

emilio

Thanks! Looks good, but let's rename SortStradegy at least to SortStrategy. I'd also prefer some other very minor renames, if you're ok with them :)

emilio · 2020-01-26T17:04:15Z

src/bindgen/config.rs

    /// An optional macro to use when generating Swift function name attributes
    pub swift_name_macro: Option<String>,
+    /// Select sort stradegy for function names
+    pub sort_by: SortStradegy,


You mean strategy, right? Not stradegy.

oh dear! 🙈

emilio · 2020-01-26T17:05:33Z

src/bindgen/library.rs


+        match self.config.function.sort_by {
+            SortStradegy::ByName => {
+                self.functions.sort_by(|x, y| x.path.cmp(&y.path));


I think this can just be sort_by_key(|x| &x.path), while you're at it.

Thanks. Learnt something new here.

emilio · 2020-01-26T17:08:31Z

docs.md

+# "ByName": sort by the name of the function
+# "Keep": keep order in which the functions have been parsed
+#
+# default: "ByName"


A bit bikesheddy, but I think this would be a bit better if the variant was just Name. At least to me sort_by = "Name" reads better than sort_by = "ByName".

Similarly, mostly for consistency with renaming options, probably the "keep" variant should be None.

You are right. This feels a lot more natural.

emilio · 2020-01-26T17:09:14Z

src/bindgen/config.rs


+/// Type which specifies the sort order of functions
+#[derive(Debug, Clone, PartialEq)]
+pub enum SortStradegy {


Probably if you agree with the naming suggestion above, this could be:

pub enum SortKey { Name, None, }

Or such.

systec-ad · 2020-01-27T07:39:04Z

I tried to use sort_by_key() and ran into lifetime errors.

error[E0495]: cannot infer an appropriate lifetime for borrow expression due to conflicting requirements

Afaik it would only work with cloning the path. What would you prefer?

emilio · 2020-01-27T15:01:48Z

sort_by seems fine then :)

emilio

Thanks, this looks great :)

* Support 'swift_name' attributes on generated functions (#449) * Add [export.pre_body] to config (#452) * Handle new line in doc attribute (#454) * Add support for `Self` in tagged enums, structs and unions (#455, #455, #456) * Make sentinel variant respect regular config (#459) * Fix layout of tagged enums with size under some configurations (#463) * Add an option to allow configuring the order of function names in generated headers (#466) Thanks to all the awesome contributors.

232: Bump cbindgen from 0.12.2 to 0.13.0 r=MikailBag a=dependabot-preview[bot] Bumps [cbindgen](https://github.com/eqrion/cbindgen) from 0.12.2 to 0.13.0. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/eqrion/cbindgen/blob/master/CHANGES">cbindgen's changelog</a>.</em></p> <blockquote> <h2>0.13.0</h2> <pre><code> * Support 'swift_name' attributes on generated functions ([#449](mozilla/cbindgen#449)) * Add [export.pre_body] to config ([#452](mozilla/cbindgen#452)) * Handle new line in doc attribute ([#454](mozilla/cbindgen#454)) * Add support for `Self` in tagged enums, structs and unions ([#455](mozilla/cbindgen#455), [#455](mozilla/cbindgen#455), [#456](mozilla/cbindgen#456)) * Make sentinel variant respect regular config ([#459](mozilla/cbindgen#459)) * Fix layout of tagged enums with size under some configurations ([#463](mozilla/cbindgen#463)) * Add an option to allow configuring the order of function names in generated headers ([#466](mozilla/cbindgen#466)) </code></pre> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/eqrion/cbindgen/commit/5e667158a144e59c221327d12cfc9f7f1c0e744b"><code>5e66715</code></a> Release v0.13.0</li> <li><a href="https://github.com/eqrion/cbindgen/commit/723e690027209c8e613c729def6a9367e197b00f"><code>723e690</code></a> Add test cases for 'sort_by' option</li> <li><a href="https://github.com/eqrion/cbindgen/commit/f5edc2c2abf474df886975b8d83a7c46332ce352"><code>f5edc2c</code></a> Document usage of 'sort_by' option</li> <li><a href="https://github.com/eqrion/cbindgen/commit/2fb3e1d9c4ef83a3014c28f21771546a2485699b"><code>2fb3e1d</code></a> Add option to specify ordering of generated C function prototypes</li> <li><a href="https://github.com/eqrion/cbindgen/commit/4cb762ec8f24f8ef3e12fcd716326a1207a88018"><code>4cb762e</code></a> Do not emit <code>enum TagName tag</code> when a sized representation is present.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/80487484196026d2efd11131d58859e2da8beee4"><code>8048748</code></a> Add a test that demonstrates Style::Tag can emit structures with incorrect si...</li> <li><a href="https://github.com/eqrion/cbindgen/commit/12248c2fef57d596dfa9245bd5fec2eabe050002"><code>12248c2</code></a> tests: Add a simple testing-helpers headers that tests can include.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/bd831ded1945ebb28cac8560a570c5522c05b945"><code>bd831de</code></a> tests: Provide style definition to the C / C++ tests.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/ec18611e583ceda551d6e0a926eac95a69b78e44"><code>ec18611</code></a> bindings: Don't add stray newline in trailer.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/e0d4bc17a54fb38857d89bdc10d24bb9242131aa"><code>e0d4bc1</code></a> Make sentinel variant respect regular config</li> <li>Additional commits viewable in <a href="https://github.com/eqrion/cbindgen/compare/v0.12.2...v0.13.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=cbindgen&package-manager=cargo&previous-version=0.12.2&new-version=0.13.0)](https://dependabot.com/compatibility-score.html?dependency-name=cbindgen&package-manager=cargo&previous-version=0.12.2&new-version=0.13.0) You can trigger a rebase of this PR 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 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) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Pull request limits (per update run and/or open at any time) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired) </details> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

Bump cbindgen from 0.9.1 to 0.14.1 Bumps [cbindgen](https://github.com/eqrion/cbindgen) from 0.9.1 to 0.14.1. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/eqrion/cbindgen/blob/master/CHANGES">cbindgen's changelog</a>.</em></p> <blockquote> <h2>0.14.1</h2> <pre><code> * Handle mangling pointers. ([#508](mozilla/cbindgen#508)) * Unconditionally generate a return statement in partialeq implementations. ([#509](mozilla/cbindgen#509)) </code></pre> <h2>0.14.0</h2> <pre><code> * Minor tweak at how [export.exclude] is handled to allow excluding generic instantiations in C mode. ([#501](mozilla/cbindgen#501)) * Documented cpp_compat option. ([#496](mozilla/cbindgen#496)) * Fixed a panic when parsing associated constants for a built-in type. ([#494](mozilla/cbindgen#494)) </code></pre> <h2>0.13.2</h2> <pre><code> * Constants now have suitable documentation. ([#471](mozilla/cbindgen#471)) * Fixed some C warnings by emitting void when there are no arguments. ([#470](mozilla/cbindgen#470)) * Avoids reading cargo.toml when not needed, which can cause panics in workspace situations. * Only write `default` cases if the switch is not exhaustive. ([#475](mozilla/cbindgen#475)) * Some warnings have been refined. ([#477](mozilla/cbindgen#477)) * Code generation for static arrays has been fixed. ([#479](mozilla/cbindgen#479)) * Opt-in support for constexpr in constants. ([#481](mozilla/cbindgen#481)) * Fix C code generation and some warnings when extremely large constants are used. ([#490](mozilla/cbindgen#490)) * Proper escaping of enum variants and fields. ([#483](mozilla/cbindgen#483)) * Added support for RefCell (as an opaque type) and Cell. ([#489](mozilla/cbindgen#489)) </code></pre> <h2>0.13.1</h2> <pre><code> * Support `#[cfg]` on individual enum variants. ([#469](mozilla/cbindgen#469)) </code></pre> <h2>0.13.0</h2> <pre><code> * Support 'swift_name' attributes on generated functions ([#449](mozilla/cbindgen#449)) * Add [export.pre_body] to config ([#452](mozilla/cbindgen#452)) * Handle new line in doc attribute ([#454](mozilla/cbindgen#454)) * Add support for `Self` in tagged enums, structs and unions ([#455](mozilla/cbindgen#455), [#455](mozilla/cbindgen#455), [#456](mozilla/cbindgen#456)) * Make sentinel variant respect regular config ([#459](mozilla/cbindgen#459)) * Fix layout of tagged enums with size under some configurations ([#463](mozilla/cbindgen#463)) * Add an option to allow configuring the order of function names in generated headers ([#466](mozilla/cbindgen#466)) </code></pre> <h2>0.12.2</h2> <pre><code> * Fixed version detection with lockfile v2. mozilla/cbindgen#446 * Added support for export_name on functions. mozilla/cbindgen#447 </code></pre> <h2>0.12.1</h2> <pre><code> * Added support for #[repr*64)] on enums. mozilla/cbindgen#441 * Added support to generate plain enums instead of enum classes for C++. mozilla/cbindgen#443 * Fixed dependency resolution with lockfile v2. mozilla/cbindgen#438 </code></pre> </tr></table> ... (truncated) </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/eqrion/cbindgen/commit/0761b9bbe48d01ded1bbec45bbeea5544b3b1002"><code>0761b9b</code></a> Release 0.14.1</li> <li><a href="https://github.com/eqrion/cbindgen/commit/33d9ecf11f300bd03f431e9f3417c063e681380c"><code>33d9ecf</code></a> Handle mangling pointers.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/0fed9eebc47abcd31e0e69357cd39262c8a5a6cc"><code>0fed9ee</code></a> enum: Unconditionally generate a return statement in partialeq implementations.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/a519f1bda444a0c6c01464296a052d9a05e1d9c4"><code>a519f1b</code></a> Actually use the temp dir for temporary compiled objects.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/4a38a48937264d6ec162b2fd47ffd0e7a091ca72"><code>4a38a48</code></a> Release 0.14.0</li> <li><a href="https://github.com/eqrion/cbindgen/commit/39bae60ad7ac4711d8fccc0d098ecef98b37d559"><code>39bae60</code></a> Generate test object files in a temporary directory instead of in-tree</li> <li><a href="https://github.com/eqrion/cbindgen/commit/ec1631f3e47686e6e0c1b7641bb08b0e39c59250"><code>ec1631f</code></a> Allow excluding monomorph structs in C mode.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/6fd245096dcd5c50c1065b4bd6ce62a09df0b39b"><code>6fd2450</code></a> Add missing cpp_compat documentation.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/c265a7562a5ee815057efcc8b1aca31cd3d5318d"><code>c265a75</code></a> parser: Don't panic when finding associated constants to a primitive.</li> <li><a href="https://github.com/eqrion/cbindgen/commit/17d7aad7d07dce8aa665aedbc75c39953afe1600"><code>17d7aad</code></a> Release v0.13.2</li> <li>Additional commits viewable in <a href="https://github.com/eqrion/cbindgen/compare/v0.9.1...v0.14.1">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=cbindgen&package-manager=cargo&previous-version=0.9.1&new-version=0.14.1)](https://dependabot.com/compatibility-score/?dependency-name=cbindgen&package-manager=cargo&previous-version=0.9.1&new-version=0.14.1) 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 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) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Pull request limits (per update run and/or open at any time) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired) </details>

systec-ad force-pushed the fn-sorting branch from 72cfbb0 to 4a8867c Compare January 26, 2020 12:57

emilio requested changes Jan 26, 2020

View reviewed changes

systec-ad added 3 commits January 27, 2020 08:33

Add option to specify ordering of generated C function prototypes

13b6fb1

Document usage of 'sort_by' option

36fe97e

Add test cases for 'sort_by' option

0f881e7

systec-ad force-pushed the fn-sorting branch from 4a8867c to 0f881e7 Compare January 27, 2020 07:35

emilio approved these changes Jan 27, 2020

View reviewed changes

emilio merged commit 723e690 into mozilla:master Jan 27, 2020

systec-ad deleted the fn-sorting branch January 27, 2020 15:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add option for sorting of function names #466

Add option for sorting of function names #466

Uh oh!

systec-ad commented Jan 26, 2020

Uh oh!

emilio left a comment

Uh oh!

emilio Jan 26, 2020

Uh oh!

systec-ad Jan 27, 2020

Uh oh!

emilio Jan 26, 2020

Uh oh!

systec-ad Jan 27, 2020

Uh oh!

emilio Jan 26, 2020

Uh oh!

systec-ad Jan 27, 2020

Uh oh!

emilio Jan 26, 2020

Uh oh!

systec-ad commented Jan 27, 2020 •

edited

Loading

Uh oh!

emilio commented Jan 27, 2020

Uh oh!

emilio left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add option for sorting of function names #466

Add option for sorting of function names #466

Uh oh!

Conversation

systec-ad commented Jan 26, 2020

Uh oh!

emilio left a comment

Choose a reason for hiding this comment

Uh oh!

emilio Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

systec-ad Jan 27, 2020

Choose a reason for hiding this comment

Uh oh!

emilio Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

systec-ad Jan 27, 2020

Choose a reason for hiding this comment

Uh oh!

emilio Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

systec-ad Jan 27, 2020

Choose a reason for hiding this comment

Uh oh!

emilio Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

systec-ad commented Jan 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

emilio commented Jan 27, 2020

Uh oh!

emilio left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

systec-ad commented Jan 27, 2020 •

edited

Loading