scroll_derive-0.12.0/Cargo.lock0000644000000024500000000000100117240ustar # This file is automatically @generated by Cargo. # It is not intended for manual editing. version = 3 [[package]] name = "proc-macro2" version = "1.0.73" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2dd5e8a1f1029c43224ad5898e50140c2aebb1705f19e67c918ebf5b9e797fe1" dependencies = [ "unicode-ident", ] [[package]] name = "quote" version = "1.0.34" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "22a37c9326af5ed140c86a46655b5278de879853be5573c01df185b6f49a580a" dependencies = [ "proc-macro2", ] [[package]] name = "scroll" version = "0.11.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "04c565b551bafbef4157586fa379538366e4385d42082f255bfd96e4fe8519da" [[package]] name = "scroll_derive" version = "0.12.0" dependencies = [ "proc-macro2", "quote", "scroll", "syn", ] [[package]] name = "syn" version = "2.0.43" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ee659fb5f3d355364e1f3e5bc10fb82068efbf824a1e9d1c9504244a6469ad53" dependencies = [ "proc-macro2", "quote", "unicode-ident", ] [[package]] name = "unicode-ident" version = "1.0.12" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" scroll_derive-0.12.0/Cargo.toml0000644000000023400000000000100117450ustar # 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 are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2018" name = "scroll_derive" version = "0.12.0" authors = [ "m4b ", "Ted Mielczarek ", "Systemcluster ", ] include = [ "src/**/*", "Cargo.toml", "LICENSE", "README.md", ] description = "A macros 1.1 derive implementation for Pread and Pwrite traits from the scroll crate" documentation = "https://docs.rs/scroll_derive" readme = "README.md" keywords = [ "derive", "macros", "pread", "pwrite", "bytes", ] license = "MIT" repository = "https://github.com/m4b/scroll" [lib] proc-macro = true [dependencies.proc-macro2] version = "1" [dependencies.quote] version = "1" [dependencies.syn] version = "2" [dev-dependencies.scroll] version = "0.11" scroll_derive-0.12.0/Cargo.toml.orig000064400000000000000000000012501046102023000154250ustar 00000000000000[package] name = "scroll_derive" version = "0.12.0" authors = ["m4b ", "Ted Mielczarek ", "Systemcluster "] readme = "README.md" edition = "2018" keywords = ["derive", "macros", "pread", "pwrite", "bytes"] repository = "https://github.com/m4b/scroll" license = "MIT" documentation = "https://docs.rs/scroll_derive" description = "A macros 1.1 derive implementation for Pread and Pwrite traits from the scroll crate" include = ["src/**/*", "Cargo.toml", "LICENSE", "README.md"] [lib] proc-macro = true [dependencies] proc-macro2 = "1" quote = "1" syn = "2" [dev-dependencies.scroll] version = "0.11" path = ".." scroll_derive-0.12.0/LICENSE000064400000000000000000000020411046102023000135420ustar 00000000000000MIT License Copyright (c) 2017 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. scroll_derive-0.12.0/README.md000064400000000000000000000017311046102023000140210ustar 00000000000000# scroll_derive Macros 1.1 implementing #[derive(Pread, Pwrite)] for https://github.com/m4b/scroll Add derive annotations to your POD seamlessly and easily: ```rust extern crate scroll; #[macro_use] extern crate scroll_derive; #[derive(Debug, PartialEq, Pread, Pwrite, IOread, IOwrite, SizeWith)] #[repr(C)] struct Data { id: u32, timestamp: f64, arr: [u16; 2], } use scroll::{Pread, Pwrite, Cread, LE}; fn main (){ let bytes = [0xefu8, 0xbe, 0xad, 0xde, 0, 0, 0, 0, 0, 0, 224, 63, 0xad, 0xde, 0xef, 0xbe]; let data: Data = bytes.pread_with(0, LE).unwrap(); println!("data: {data:?}"); assert_eq!(data.id, 0xdeadbeefu32); let mut bytes2 = vec![0; ::std::mem::size_of::()]; bytes2.pwrite_with(data, 0, LE).unwrap(); let data: Data = bytes.pread_with(0, LE).unwrap(); let data2: Data = bytes2.pread_with(0, LE).unwrap(); assert_eq!(data, data2); let data: Data = bytes.cread_with(0, LE); assert_eq!(data, data2); } ``` scroll_derive-0.12.0/src/lib.rs000064400000000000000000000445541046102023000144570ustar 00000000000000#![recursion_limit = "1024"] extern crate proc_macro; use proc_macro2; use quote::quote; use proc_macro::TokenStream; fn impl_field(ident: &proc_macro2::TokenStream, ty: &syn::Type) -> proc_macro2::TokenStream { match *ty { syn::Type::Array(ref array) => match array.len { syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(ref int), .. }) => { let size = int.base10_parse::().unwrap(); quote! { #ident: { let mut __tmp: #ty = [0u8.into(); #size]; src.gread_inout_with(offset, &mut __tmp, ctx)?; __tmp } } } _ => panic!("Pread derive with bad array constexpr"), }, syn::Type::Group(ref group) => impl_field(ident, &group.elem), _ => { quote! { #ident: src.gread_with::<#ty>(offset, ctx)? } } } } fn impl_struct( name: &syn::Ident, fields: &syn::punctuated::Punctuated, generics: &syn::Generics, ) -> proc_macro2::TokenStream { let items: Vec<_> = fields .iter() .enumerate() .map(|(i, f)| { let ident = &f.ident.as_ref().map(|i| quote! {#i}).unwrap_or({ let t = proc_macro2::Literal::usize_unsuffixed(i); quote! {#t} }); let ty = &f.ty; impl_field(ident, ty) }) .collect(); let gl = &generics.lt_token; let gp = &generics.params; let gg = &generics.gt_token; let gn = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident } } p => quote! { #p }, }); let gn = quote! { #gl #( #gn ),* #gg }; let gw = if !gp.is_empty() { let gi = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident : ::scroll::ctx::TryFromCtx<'a, ::scroll::Endian> + ::std::convert::From + ::std::marker::Copy, ::scroll::Error : ::std::convert::From<< #ident as ::scroll::ctx::TryFromCtx<'a, ::scroll::Endian>>::Error>, < #ident as ::scroll::ctx::TryFromCtx<'a, ::scroll::Endian>>::Error : ::std::convert::From } }, p => quote! { #p } }); quote! { #( #gi ),* , } } else { quote! {} }; quote! { impl<'a, #gp > ::scroll::ctx::TryFromCtx<'a, ::scroll::Endian> for #name #gn where #gw #name #gn : 'a { type Error = ::scroll::Error; #[inline] fn try_from_ctx(src: &'a [u8], ctx: ::scroll::Endian) -> ::scroll::export::result::Result<(Self, usize), Self::Error> { use ::scroll::Pread; let offset = &mut 0; let data = Self { #(#items,)* }; Ok((data, *offset)) } } } } fn impl_try_from_ctx(ast: &syn::DeriveInput) -> proc_macro2::TokenStream { let name = &ast.ident; let generics = &ast.generics; match ast.data { syn::Data::Struct(ref data) => match data.fields { syn::Fields::Named(ref fields) => impl_struct(name, &fields.named, generics), syn::Fields::Unnamed(ref fields) => impl_struct(name, &fields.unnamed, generics), _ => { panic!("Pread can not be derived for unit structs") } }, _ => panic!("Pread can only be derived for structs"), } } #[proc_macro_derive(Pread)] pub fn derive_pread(input: TokenStream) -> TokenStream { let ast: syn::DeriveInput = syn::parse(input).unwrap(); let gen = impl_try_from_ctx(&ast); gen.into() } fn impl_pwrite_field(ident: &proc_macro2::TokenStream, ty: &syn::Type) -> proc_macro2::TokenStream { match ty { syn::Type::Array(ref array) => match array.len { syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(ref int), .. }) => { let size = int.base10_parse::().unwrap(); quote! { for i in 0..#size { dst.gwrite_with(&self.#ident[i], offset, ctx)?; } } } _ => panic!("Pwrite derive with bad array constexpr"), }, syn::Type::Group(group) => impl_pwrite_field(ident, &group.elem), _ => { quote! { dst.gwrite_with(&self.#ident, offset, ctx)? } } } } fn impl_try_into_ctx( name: &syn::Ident, fields: &syn::punctuated::Punctuated, generics: &syn::Generics, ) -> proc_macro2::TokenStream { let items: Vec<_> = fields .iter() .enumerate() .map(|(i, f)| { let ident = &f.ident.as_ref().map(|i| quote! {#i}).unwrap_or({ let t = proc_macro2::Literal::usize_unsuffixed(i); quote! {#t} }); let ty = &f.ty; impl_pwrite_field(ident, ty) }) .collect(); let gl = &generics.lt_token; let gp = &generics.params; let gg = &generics.gt_token; let gn = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident } } p => quote! { #p }, }); let gn = quote! { #gl #( #gn ),* #gg }; let gwref = if !gp.is_empty() { let gi = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { &'a #ident : ::scroll::ctx::TryIntoCtx<::scroll::Endian>, ::scroll::Error: ::std::convert::From<<&'a #ident as ::scroll::ctx::TryIntoCtx<::scroll::Endian>>::Error>, <&'a #ident as ::scroll::ctx::TryIntoCtx<::scroll::Endian>>::Error: ::std::convert::From } }, p => quote! { #p } }); quote! { where #( #gi ),* } } else { quote! {} }; let gw = if !gp.is_empty() { let gi = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident : ::scroll::ctx::TryIntoCtx<::scroll::Endian>, ::scroll::Error: ::std::convert::From<<#ident as ::scroll::ctx::TryIntoCtx<::scroll::Endian>>::Error>, <#ident as ::scroll::ctx::TryIntoCtx<::scroll::Endian>>::Error: ::std::convert::From } }, p => quote! { #p } }); quote! { where Self: ::std::marker::Copy, #( #gi ),* } } else { quote! {} }; quote! { impl<'a, #gp > ::scroll::ctx::TryIntoCtx<::scroll::Endian> for &'a #name #gn #gwref { type Error = ::scroll::Error; #[inline] fn try_into_ctx(self, dst: &mut [u8], ctx: ::scroll::Endian) -> ::scroll::export::result::Result { use ::scroll::Pwrite; let offset = &mut 0; #(#items;)*; Ok(*offset) } } impl #gl #gp #gg ::scroll::ctx::TryIntoCtx<::scroll::Endian> for #name #gn #gw { type Error = ::scroll::Error; #[inline] fn try_into_ctx(self, dst: &mut [u8], ctx: ::scroll::Endian) -> ::scroll::export::result::Result { (&self).try_into_ctx(dst, ctx) } } } } fn impl_pwrite(ast: &syn::DeriveInput) -> proc_macro2::TokenStream { let name = &ast.ident; let generics = &ast.generics; match ast.data { syn::Data::Struct(ref data) => match data.fields { syn::Fields::Named(ref fields) => impl_try_into_ctx(name, &fields.named, generics), syn::Fields::Unnamed(ref fields) => impl_try_into_ctx(name, &fields.unnamed, generics), _ => { panic!("Pwrite can not be derived for unit structs") } }, _ => panic!("Pwrite can only be derived for structs"), } } #[proc_macro_derive(Pwrite)] pub fn derive_pwrite(input: TokenStream) -> TokenStream { let ast: syn::DeriveInput = syn::parse(input).unwrap(); let gen = impl_pwrite(&ast); gen.into() } fn size_with( name: &syn::Ident, fields: &syn::punctuated::Punctuated, generics: &syn::Generics, ) -> proc_macro2::TokenStream { let items: Vec<_> = fields .iter() .map(|f| { let ty = &f.ty; match *ty { syn::Type::Array(ref array) => { let elem = &array.elem; match array.len { syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(ref int), .. }) => { let size = int.base10_parse::().unwrap(); quote! { (#size * <#elem>::size_with(ctx)) } } _ => panic!("Pread derive with bad array constexpr"), } } _ => { quote! { <#ty>::size_with(ctx) } } } }) .collect(); let gl = &generics.lt_token; let gp = &generics.params; let gg = &generics.gt_token; let gn = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident } } p => quote! { #p }, }); let gn = quote! { #gl #( #gn ),* #gg }; let gw = if !gp.is_empty() { let gi = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident : ::scroll::ctx::SizeWith<::scroll::Endian> } } p => quote! { #p }, }); quote! { where #( #gi ),* } } else { quote! {} }; quote! { impl #gl #gp #gg ::scroll::ctx::SizeWith<::scroll::Endian> for #name #gn #gw { #[inline] fn size_with(ctx: &::scroll::Endian) -> usize { 0 #(+ #items)* } } } } fn impl_size_with(ast: &syn::DeriveInput) -> proc_macro2::TokenStream { let name = &ast.ident; let generics = &ast.generics; match ast.data { syn::Data::Struct(ref data) => match data.fields { syn::Fields::Named(ref fields) => size_with(name, &fields.named, generics), syn::Fields::Unnamed(ref fields) => size_with(name, &fields.unnamed, generics), _ => { panic!("SizeWith can not be derived for unit structs") } }, _ => panic!("SizeWith can only be derived for structs"), } } #[proc_macro_derive(SizeWith)] pub fn derive_sizewith(input: TokenStream) -> TokenStream { let ast: syn::DeriveInput = syn::parse(input).unwrap(); let gen = impl_size_with(&ast); gen.into() } fn impl_cread_struct( name: &syn::Ident, fields: &syn::punctuated::Punctuated, generics: &syn::Generics, ) -> proc_macro2::TokenStream { let items: Vec<_> = fields.iter().enumerate().map(|(i, f)| { let ident = &f.ident.as_ref().map(|i|quote!{#i}).unwrap_or({let t = proc_macro2::Literal::usize_unsuffixed(i); quote!{#t}}); let ty = &f.ty; match *ty { syn::Type::Array(ref array) => { let arrty = &array.elem; match array.len { syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(ref int), ..}) => { let size = int.base10_parse::().unwrap(); let incr = quote! { ::scroll::export::mem::size_of::<#arrty>() }; quote! { #ident: { let mut __tmp: #ty = [0u8.into(); #size]; for i in 0..__tmp.len() { __tmp[i] = src.cread_with(*offset, ctx); *offset += #incr; } __tmp } } }, _ => panic!("IOread derive with bad array constexpr") } }, _ => { let size = quote! { ::scroll::export::mem::size_of::<#ty>() }; quote! { #ident: { let res = src.cread_with::<#ty>(*offset, ctx); *offset += #size; res } } } } }).collect(); let gl = &generics.lt_token; let gp = &generics.params; let gg = &generics.gt_token; let gn = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident } } p => quote! { #p }, }); let gn = quote! { #gl #( #gn ),* #gg }; let gw = if !gp.is_empty() { let gi = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident : ::scroll::ctx::FromCtx<::scroll::Endian> + ::std::convert::From + ::std::marker::Copy } }, p => quote! { #p } }); quote! { where #( #gi ),* , } } else { quote! {} }; quote! { impl #gl #gp #gg ::scroll::ctx::FromCtx<::scroll::Endian> for #name #gn #gw { #[inline] fn from_ctx(src: &[u8], ctx: ::scroll::Endian) -> Self { use ::scroll::Cread; let offset = &mut 0; let data = Self { #(#items,)* }; data } } } } fn impl_from_ctx(ast: &syn::DeriveInput) -> proc_macro2::TokenStream { let name = &ast.ident; let generics = &ast.generics; match ast.data { syn::Data::Struct(ref data) => match data.fields { syn::Fields::Named(ref fields) => impl_cread_struct(name, &fields.named, generics), syn::Fields::Unnamed(ref fields) => impl_cread_struct(name, &fields.unnamed, generics), _ => { panic!("IOread can not be derived for unit structs") } }, _ => panic!("IOread can only be derived for structs"), } } #[proc_macro_derive(IOread)] pub fn derive_ioread(input: TokenStream) -> TokenStream { let ast: syn::DeriveInput = syn::parse(input).unwrap(); let gen = impl_from_ctx(&ast); gen.into() } fn impl_into_ctx( name: &syn::Ident, fields: &syn::punctuated::Punctuated, generics: &syn::Generics, ) -> proc_macro2::TokenStream { let items: Vec<_> = fields .iter() .enumerate() .map(|(i, f)| { let ident = &f.ident.as_ref().map(|i| quote! {#i}).unwrap_or({ let t = proc_macro2::Literal::usize_unsuffixed(i); quote! {#t} }); let ty = &f.ty; let size = quote! { ::scroll::export::mem::size_of::<#ty>() }; match *ty { syn::Type::Array(ref array) => { let arrty = &array.elem; quote! { let size = ::scroll::export::mem::size_of::<#arrty>(); for i in 0..self.#ident.len() { dst.cwrite_with(self.#ident[i], *offset, ctx); *offset += size; } } } _ => { quote! { dst.cwrite_with(self.#ident, *offset, ctx); *offset += #size; } } } }) .collect(); let gl = &generics.lt_token; let gp = &generics.params; let gg = &generics.gt_token; let gn = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident } } p => quote! { #p }, }); let gw = if !gp.is_empty() { let gi = gp.iter().map(|param: &syn::GenericParam| match param { syn::GenericParam::Type(ref t) => { let ident = &t.ident; quote! { #ident : ::scroll::ctx::IntoCtx<::scroll::Endian> + ::std::marker::Copy } } p => quote! { #p }, }); quote! { where #( #gi ),* } } else { quote! {} }; let gn = quote! { #gl #( #gn ),* #gg }; quote! { impl<'a, #gp > ::scroll::ctx::IntoCtx<::scroll::Endian> for &'a #name #gn #gw { #[inline] fn into_ctx(self, dst: &mut [u8], ctx: ::scroll::Endian) { use ::scroll::Cwrite; let offset = &mut 0; #(#items;)*; () } } impl #gl #gp #gg ::scroll::ctx::IntoCtx<::scroll::Endian> for #name #gn #gw { #[inline] fn into_ctx(self, dst: &mut [u8], ctx: ::scroll::Endian) { (&self).into_ctx(dst, ctx) } } } } fn impl_iowrite(ast: &syn::DeriveInput) -> proc_macro2::TokenStream { let name = &ast.ident; let generics = &ast.generics; match ast.data { syn::Data::Struct(ref data) => match data.fields { syn::Fields::Named(ref fields) => impl_into_ctx(name, &fields.named, generics), syn::Fields::Unnamed(ref fields) => impl_into_ctx(name, &fields.unnamed, generics), _ => { panic!("IOwrite can not be derived for unit structs") } }, _ => panic!("IOwrite can only be derived for structs"), } } #[proc_macro_derive(IOwrite)] pub fn derive_iowrite(input: TokenStream) -> TokenStream { let ast: syn::DeriveInput = syn::parse(input).unwrap(); let gen = impl_iowrite(&ast); gen.into() }