commit cca7592fbd4e75b05a316f8f21ce68bd3a5aeb00 Author: Nicolas Stalder Date: Sat Jan 11 15:31:04 2020 +0100 Initial commit: Basic serialization diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6936990 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..0389ae1 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,24 @@ +[package] +name = "serde-indexed" +version = "0.0.0-unreleased" +authors = ["Nicolas Stalder "] +license = "MIT OR Apache-2.0" +description = "Derive Serialize and Deserialize that replaces struct keys with numerical indices." +repository = "https://github.com/nickray/serde-indexed" +readme = "README.md" +edition = "2018" + +[lib] +proc-macro = true + +[dependencies] +proc-macro2 = "1.0" +quote = "1.0" +syn = "1.0" + +[dev-dependencies] +# heapless = "0.5.1" +# rustversion = "1.0" +serde = "1.0" +serde_cbor = "0.11.0" +# trybuild = { version = "1.0.19", features = ["diff"] } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..cd482d8 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ +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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..1327a0c --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2020 Nicolas Stalder + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d36196 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +## Overview + +Derive Serialize and Deserialize that replaces struct keys with numerical indices. + +Supports `skip_serializing_if` for optional keys. + +**WIP**. Use case is to handle CTAP CBOR messages. + +This is my attempt to learn and use using proc-macros, +I'm following along with [`serde-repr`][serde-repr]. + +To "see" the generated code, run `cargo expand --test basics`. + +[serde-repr]: https://github.com/dtolnay/serde-repr + +#### License + +`serde-indexed` is licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option. +
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..7b01a45 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,57 @@ +//! Derive `Serialize` and `Deserialize` that replaces struct keys with numerical indices. + +extern crate proc_macro; + +mod parse; + +use proc_macro::TokenStream; +use quote::quote; +use syn::parse_macro_input; + +use crate::parse::Input; + +fn serialize_visitor(fields: &[parse::Field], offset: usize) -> Vec { + fields + .iter() + .map(|field| { + let index = field.index + offset; + // let label = stringify!(field.label.clone()); + let member = &field.member; + quote! { + // TODO: how do I get something like `self.#label` here? + // TODO: what the heck is "member"? + map.serialize_entry(&#index, &self.#member)?; + } + }) + .collect() +} + +#[proc_macro_derive(SerializeIndexed)] +pub fn derive_serialize(input: TokenStream) -> TokenStream { + let input = parse_macro_input!(input as Input); + let ident = input.ident; + let num_fields = input.fields.len(); + let serialize_fields = serialize_visitor(&input.fields, 1); + + TokenStream::from(quote! { + impl serde::Serialize for #ident { + fn serialize(&self, serializer: S) -> core::result::Result + where + S: serde::Serializer + { + // Somehow: + // - serialize_struct takes an identifier + // - serialize_map does *not* + // let mut state = serializer.serialize_struct(stringify!(#ident), #num_fields)?; + + use serde::ser::SerializeMap; + let mut map = serializer.serialize_map(Some(#num_fields))?; + + #(#serialize_fields)* + + map.end() + } + } + }) +} + diff --git a/src/parse.rs b/src/parse.rs new file mode 100644 index 0000000..0c76a9d --- /dev/null +++ b/src/parse.rs @@ -0,0 +1,83 @@ +// use syn::parse::{Error, Parse, ParseStream, Parser, Result}; +// use syn::{parenthesized, Data, DeriveInput, Fields, Ident, Meta, NestedMeta}; + +use proc_macro2::Span; +use syn::parse::{Error, Parse, ParseStream, Result}; +use syn::{Data, DeriveInput, Fields, Ident}; +use syn::Token; + +pub struct Input { + pub ident: Ident, + pub fields: Vec, +} + +pub struct Field { + pub label: String, + pub member: syn::Member, + pub index: usize, + // pub attrs: attr::Field, + pub ty: syn::Type, + pub original: syn::Field, +} + +impl Parse for Input { + + fn parse(input: ParseStream) -> Result { + let call_site = Span::call_site(); + let derive_input = DeriveInput::parse(input)?; + + let data: syn::DataStruct = match derive_input.data { + Data::Struct(data) => data, + _ => { + return Err(Error::new(call_site, "input must be a struct")); + } + }; + + let syn_fields: syn::FieldsNamed = match data.fields { + Fields::Named(named_fields) => named_fields, + _ => { + return Err(Error::new(call_site, "struct fields must be named")); + } + }; + + let fields = fields_from_ast(&syn_fields.named); + + //serde::internals::ast calls `fields_from_ast(cx, &fields.named, attrs, container_default)` + + Ok(Input { + ident: derive_input.ident, + fields, + }) + } +} + +fn fields_from_ast<'a>( + fields: &'a syn::punctuated::Punctuated, +) -> Vec { + // serde::internals::ast.rs:L183 + fields + .iter() + .enumerate() + .map(|(i, field)| Field { + // these are https://docs.rs/syn/1.0.13/syn/struct.Field.html + label: match &field.ident { + Some(ident) => ident.to_string(), + None => { + // TODO: does this happen? + panic!("input struct must have named fields"); + } + }, + member: match &field.ident { + Some(ident) => syn::Member::Named(ident.clone()), + None => { + // TODO: does this happen? + panic!("input struct must have named fields"); + } + }, + index: i, + ty: field.ty.clone(), + original: field.clone(), + }) + .collect() +} + diff --git a/tests/basics.rs b/tests/basics.rs new file mode 100644 index 0000000..6fb7126 --- /dev/null +++ b/tests/basics.rs @@ -0,0 +1,57 @@ +use serde_indexed::{/*DeserializeIndexed,*/ SerializeIndexed}; + +mod some_keys { + use super::*; + + // use heapless::{ + // consts, + // String, + // Vec, + // }; + + // TODO Does this import belong here or in the macro? + + // use serde::ser::SerializeMap; + #[derive(Clone, Debug, PartialEq, SerializeIndexed)] + // #[serde_indexed(offset = 1)] + pub struct SomeKeys { + pub number: i32, + pub bytes: [u8; 12], + // pub string: String, + // pub vector: Vec, + } + + fn an_example() -> SomeKeys { + SomeKeys { number: -7, bytes: [37u8; 12] } + } + + // TODO: add some kind of bytes, e.g. + // cbor.dumps({1: -7, 2: bytes([42]*12)}) = b'\xa2\x01&\x02L************' + const SERIALIZED_AN_EXAMPLE: &'static [u8] = + b"\xa2\x01&\x02\x8c\x18%\x18%\x18%\x18%\x18%\x18%\x18%\x18%\x18%\x18%\x18%\x18%"; + + #[test] + fn test_serialize() { + let sk = an_example(); + + let mut buffer = [0u8; 1024]; + let writer = serde_cbor::ser::SliceWrite::new(&mut buffer); + let mut ser = serde_cbor::Serializer::new(writer); + + use serde::ser::Serialize; + + // CURRENTLY: stack overflow, as it recursively calls itself + sk.serialize(&mut ser).unwrap(); + + let writer = ser.into_inner(); + let size = writer.bytes_written(); + + assert_eq!(&buffer[..size], SERIALIZED_AN_EXAMPLE); + } + + // #[test] + // fn test_deserialize() { + // let sk = an_example(); + // } + +}