wrapcenum-derive-0.4.0/.cargo_vcs_info.json0000644000000001121367201054400144040ustar00{ "git": { "sha1": "1cf27e7b904a4506f1d29381c72f3e7da6ebc6e5" } } wrapcenum-derive-0.4.0/.gitignore010064400017500001750000000000211366137326000152010ustar0000000000000000target Cargo.lockwrapcenum-derive-0.4.0/CHANGELOG.md010064400017500001750000000021741367201005100150210ustar0000000000000000# wrapcenum-derive Changelog This file describes the changes / additions / fixes between macro releases. ## 0.4.0 (releasted 2020-06-15) ### Release Summary Re-wrote the macro to use `darling` and the `1.0` versions of `syn` and `quote`. ### Changes The error type that is expected to be in scope is now `NvmlError`. ### Removals * Support for the `default` attribute has been removed ## 0.3.0 (released 2017-07-20) ### Changes The `UnexpectedVariant` error kind is now expected to hold the value that caused the error. ## 0.2.0 (released 2017-06-08) ### Release Summary The macro is now meant to be used with numerical constants instead of Rust enums. This was done for safety reasons; see [rust-lang/rust#36927](https://github.com/rust-lang/rust/issues/36927) for more information. ### Changes * `has_count` attribute removed and replaced with `default` ## 0.1.0 (released 2017-05-17) ### Release Summary Initial release providing the functionality necessary to wrap Rust `enum`-based C enum bindings. ```text derive on Rust enum `Foo` `Foo` wraps Rust enum `Bar` `Bar` was auto-generated within bindings for C enum `Bar` ``` wrapcenum-derive-0.4.0/Cargo.toml0000644000000017171367201054400124160ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] edition = "2018" name = "wrapcenum-derive" version = "0.4.0" authors = ["Cldfire"] description = "Derive macro for nvml-wrapper, not for general use" readme = "README.md" license = "MIT/Apache-2.0" repository = "https://github.com/Cldfire/wrapcenum-derive" [lib] proc-macro = true [dependencies.darling] version = "0.10" [dependencies.proc-macro2] version = "1.0" [dependencies.quote] version = "1.0" [dependencies.syn] version = "1.0" wrapcenum-derive-0.4.0/Cargo.toml.orig010064400017500001750000000005631367200764400161150ustar0000000000000000[package] name = "wrapcenum-derive" version = "0.4.0" authors = ["Cldfire"] description = "Derive macro for nvml-wrapper, not for general use" readme = "README.md" repository = "https://github.com/Cldfire/wrapcenum-derive" license = "MIT/Apache-2.0" edition = "2018" [dependencies] syn = "1.0" quote = "1.0" darling = "0.10" proc-macro2 = "1.0" [lib] proc-macro = true wrapcenum-derive-0.4.0/LICENSE-APACHE010064400017500001750000000261371366137326000151550ustar0000000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. wrapcenum-derive-0.4.0/LICENSE-MIT010064400017500001750000000020531366137326000146540ustar0000000000000000MIT License Copyright (c) 2017 Jarek Samic Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.wrapcenum-derive-0.4.0/README.md010064400017500001750000000020111367201031100144540ustar0000000000000000# wrapcenum-derive Internal macro used in [nvml-wrapper](https://github.com/Cldfire/nvml-wrapper). This macro is tied to the crate and is not meant for use by the general public. Its purpose is to auto-generate both a `TryFrom` implementation converting an `i32` into a Rust enum (specifically for converting a C enum represented as an integer that has come over FFI) and an `as_c` method for converting the Rust enum back into an `i32`. It wouldn't take much effort to turn this into something usable by others; if you're interested feel free to contribute or file an issue asking me to put some work into it. #### License Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. wrapcenum-derive-0.4.0/src/lib.rs010064400017500001750000000067601367200700600151260ustar0000000000000000/*! Internal macro used in [nvml-wrapper](https://github.com/Cldfire/nvml-wrapper). This macro is tied to the crate and is not meant for use by the general public. Its purpose is to auto-generate both a `TryFrom` implementation converting an `i32` into a Rust enum (specifically for converting a C enum represented as an integer that has come over FFI) and an `as_c` method for converting the Rust enum back into an `i32`. It wouldn't take much effort to turn this into something usable by others; if you're interested feel free to contribute or file an issue asking me to put some work into it. */ use proc_macro2::{Ident, Span, TokenStream}; use quote::{quote, ToTokens}; use syn; use darling::{ast, FromVariant, FromDeriveInput}; /// Handles parsing attributes on the enum itself #[derive(Debug, FromDeriveInput)] #[darling(attributes(wrap), supports(enum_any))] struct EnumReceiver { ident: Ident, data: ast::Data, /// The ident of the C enum to be wrapped c_enum: String, } impl ToTokens for EnumReceiver { fn to_tokens(&self, tokens: &mut TokenStream) { let EnumReceiver { ref ident, ref data, ref c_enum, } = *self; let join_c_name_and_variant = |name: &str, variant: &str| { Ident::new(&format!("{}_{}", &name, variant), Span::call_site()) }; let c_name = Ident::new(c_enum, Span::call_site()); let rust_name = ident; let variants = data .as_ref() .take_enum() .expect("should never be a struct"); let as_arms = variants .iter() .map(|v| { let c_joined = join_c_name_and_variant(&c_name.to_string(), &v.c_variant); let v_ident = &v.ident; quote! { #rust_name::#v_ident => #c_joined, } }) .collect::>(); let try_from_arms = variants .into_iter() .map(|v| { let c_joined = join_c_name_and_variant(&c_name.to_string(), &v.c_variant); let v_ident = &v.ident; quote! { #c_joined => Ok(#rust_name::#v_ident), } }) .collect::>(); tokens.extend(quote! { impl #rust_name { /// Returns the C enum variant equivalent for the given Rust enum variant pub fn as_c(&self) -> #c_name { match *self { #(#as_arms)* } } } impl ::std::convert::TryFrom<#c_name> for #rust_name { type Error = NvmlError; fn try_from(data: #c_name) -> Result { match data { #(#try_from_arms)* _ => Err(NvmlError::UnexpectedVariant(data)), } } } }); } } /// Handles parsing attributes on enum variants #[derive(Debug, FromVariant)] #[darling(attributes(wrap))] struct VariantReceiver { ident: Ident, /// The ident of the C enum variant this Rust variant maps to c_variant: String } #[proc_macro_derive(EnumWrapper, attributes(wrap))] pub fn wrapcenum_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let ast = syn::parse(input).unwrap(); let receiver = EnumReceiver::from_derive_input(&ast).unwrap(); quote!(#receiver).into() }