use workspace
This commit is contained in:
stelzo
parent
86968303d7
commit
ed0c08ada9
|
|
@ -1,22 +0,0 @@
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [created]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
|
|
||||||
- name: Setup Rust
|
|
||||||
uses: actions-rs/toolchain@v1
|
|
||||||
with:
|
|
||||||
toolchain: stable
|
|
||||||
override: true
|
|
||||||
|
|
||||||
- name: Publish to crates.io
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: publish
|
|
||||||
args: --token ${{ secrets.CRATES_IO_TOKEN }}
|
|
||||||
|
|
@ -17,5 +17,5 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- run: docker build . --file ./tests/Dockerfile_r2r_galactic --tag r2r_galactic
|
- run: docker build . --file ./rpcl2/tests/Dockerfile_r2r_galactic --tag r2r_galactic
|
||||||
- run: docker run r2r_galactic cargo test --features r2r_msg,derive,nalgebra,rayon
|
- run: docker run r2r_galactic cargo test --features r2r_msg,derive,nalgebra,rayon
|
||||||
|
|
|
||||||
|
|
@ -17,5 +17,5 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- run: docker build . --file ./tests/Dockerfile_r2r_humble --tag r2r_humble
|
- run: docker build . --file ./rpcl2/tests/Dockerfile_r2r_humble --tag r2r_humble
|
||||||
- run: docker run r2r_humble cargo test --features r2r_msg,derive,nalgebra,rayon
|
- run: docker run r2r_humble cargo test --features r2r_msg,derive,nalgebra,rayon
|
||||||
|
|
|
||||||
|
|
@ -17,5 +17,5 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- run: docker build . --file ./tests/Dockerfile_r2r_iron --tag r2r_iron
|
- run: docker build . --file ./rpcl2/tests/Dockerfile_r2r_iron --tag r2r_iron
|
||||||
- run: docker run r2r_iron cargo test --features r2r_msg,derive,nalgebra,rayon
|
- run: docker run r2r_iron cargo test --features r2r_msg,derive,nalgebra,rayon
|
||||||
|
|
|
||||||
|
|
@ -17,5 +17,5 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- run: docker build . --file ./tests/Dockerfile_rclrs_humble --tag rclrs_humble
|
- run: docker build . --file ./rpcl2/tests/Dockerfile_rclrs_humble --tag rclrs_humble
|
||||||
- run: docker run rclrs_humble cargo test --features derive,nalgebra,rayon
|
- run: docker run rclrs_humble cargo test --features derive,nalgebra,rayon
|
||||||
|
|
|
||||||
|
|
@ -17,5 +17,5 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- run: docker build . --file ./tests/Dockerfile_rclrs_iron --tag rclrs_iron
|
- run: docker build . --file ./rpcl2/tests/Dockerfile_rclrs_iron --tag rclrs_iron
|
||||||
- run: docker run rclrs_iron cargo test --features derive,nalgebra,rayon
|
- run: docker run rclrs_iron cargo test --features derive,nalgebra,rayon
|
||||||
|
|
|
||||||
64
Cargo.toml
64
Cargo.toml
|
|
@ -1,63 +1,5 @@
|
||||||
[package]
|
[workspace]
|
||||||
name = "ros_pointcloud2"
|
|
||||||
version = "0.5.0-rc.1"
|
|
||||||
edition = "2021"
|
|
||||||
authors = ["Christopher Sieh <stelzo@steado.de>"]
|
|
||||||
description = "Customizable conversions for working with sensor_msgs/PointCloud2."
|
|
||||||
repository = "https://github.com/stelzo/ros_pointcloud2"
|
|
||||||
license = "MIT OR Apache-2.0"
|
|
||||||
keywords = ["ros", "pointcloud2", "pointcloud", "message"]
|
|
||||||
categories = [
|
|
||||||
"science::robotics",
|
|
||||||
"encoding",
|
|
||||||
"data-structures",
|
|
||||||
"api-bindings",
|
|
||||||
]
|
|
||||||
readme = "README.md"
|
|
||||||
documentation = "https://docs.rs/ros_pointcloud2"
|
|
||||||
homepage = "https://github.com/stelzo/ros_pointcloud2"
|
|
||||||
exclude = [
|
|
||||||
"**/.github/**",
|
|
||||||
"**/tests/**",
|
|
||||||
"**/examples/**",
|
|
||||||
"**/benches/**",
|
|
||||||
"**/target/**",
|
|
||||||
"**/build/**",
|
|
||||||
"**/dist/**",
|
|
||||||
"**/docs/**",
|
|
||||||
"**/doc/**",
|
|
||||||
]
|
|
||||||
rust-version = "1.63"
|
|
||||||
|
|
||||||
[dependencies]
|
members = ["rpcl2", "rpcl2-derive"]
|
||||||
rosrust_msg = { version = "0.1", optional = true }
|
|
||||||
rosrust = { version = "0.9.11", optional = true }
|
|
||||||
r2r = { version = "0.8.4", optional = true }
|
|
||||||
rayon = { version = "1", optional = true }
|
|
||||||
nalgebra = { version = "0.32.5", optional = true, default-features = false }
|
|
||||||
rpcl2_derive = { path = "rpcl2_derive", optional = true }
|
|
||||||
type-layout = { path = "type-layout", optional = true }
|
|
||||||
|
|
||||||
[dev-dependencies]
|
|
||||||
rand = "0.8"
|
|
||||||
criterion = { version = "0.5", features = ["html_reports"] }
|
|
||||||
|
|
||||||
[[bench]]
|
|
||||||
name = "roundtrip"
|
|
||||||
harness = false
|
|
||||||
|
|
||||||
[features]
|
|
||||||
rosrust_msg = ["dep:rosrust_msg", "dep:rosrust"]
|
|
||||||
r2r_msg = ["dep:r2r"]
|
|
||||||
rayon = ["dep:rayon"]
|
|
||||||
derive = ["dep:rpcl2_derive", "dep:type-layout"]
|
|
||||||
nalgebra = ["dep:nalgebra"]
|
|
||||||
std = ["nalgebra/std"]
|
|
||||||
|
|
||||||
default = ["std", "derive"]
|
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
|
||||||
features = ["derive", "nalgebra", "rayon"]
|
|
||||||
default-target = "x86_64-unknown-linux-gnu"
|
|
||||||
rustdoc-args = ["--cfg", "docsrs"]
|
|
||||||
|
|
||||||
|
resolver = "2"
|
||||||
|
|
|
||||||
|
|
@ -107,12 +107,6 @@ Licensed under either of
|
||||||
|
|
||||||
at your option.
|
at your option.
|
||||||
|
|
||||||
### type-layout
|
|
||||||
|
|
||||||
For compatibility reasons, a patched version of `type-layout` is included in this repository. The original crate can be found [here](https://crates.io/crates/type-layout). After the patch is applied on the original `type-layout` crate ([PR](https://github.com/LPGhatguy/type-layout/pull/9)), the local dependency will be changed to the original crate.
|
|
||||||
|
|
||||||
`type-layout` is licensed under MIT or Apache-2.0 and Copyright by Lucien Greathouse. The changes are highlighted in the diff of the PR.
|
|
||||||
|
|
||||||
### Contribution
|
### Contribution
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
[package]
|
||||||
|
name = "rpcl2-derive"
|
||||||
|
description = "Derive macros for ros_pointcloud2 crate."
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2021"
|
||||||
|
authors = ["Christopher Sieh <stelzo@steado.de>"]
|
||||||
|
homepage = "https://github.com/stelzo/ros_pointcloud2"
|
||||||
|
license = "MIT OR Apache-2.0"
|
||||||
|
keywords = ["ros", "pointcloud2", "ros_pointcloud2"]
|
||||||
|
categories = [
|
||||||
|
"science::robotics",
|
||||||
|
"encoding",
|
||||||
|
"data-structures",
|
||||||
|
"api-bindings",
|
||||||
|
]
|
||||||
|
repository = "https://github.com/stelzo/ros_pointcloud2"
|
||||||
|
|
||||||
|
[lib]
|
||||||
|
proc-macro = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
syn = "2.0"
|
||||||
|
quote = "1.0"
|
||||||
|
proc-macro2 = "1.0"
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
<p align="center">
|
||||||
|
<h3 align="center">ROS PointCloud2</h3>
|
||||||
|
<p align="center">Derive macros for the ros_pointcloud2 library.</p>
|
||||||
|
<p align="center"><a href="https://crates.io/crates/ros_pointcloud2"><img src="https://img.shields.io/crates/v/ros_pointcloud2.svg" alt=""></a> <a href="https://github.com/stelzo/ros_pointcloud2/tree/main/tests"><img src="https://github.com/stelzo/ros_pointcloud2/actions/workflows/tests.yml/badge.svg" alt=""></a>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
This crate should be used in combination with the `ros_pointcloud2` crate.
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
//! This crate provides macros for `ros_pointcloud2` and should be used in combination with said crate.
|
||||||
extern crate proc_macro;
|
extern crate proc_macro;
|
||||||
|
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
@ -30,7 +31,7 @@ fn struct_field_rename_array(input: &DeriveInput) -> Vec<String> {
|
||||||
|
|
||||||
let mut field_names = Vec::with_capacity(fields.len());
|
let mut field_names = Vec::with_capacity(fields.len());
|
||||||
for f in fields.iter() {
|
for f in fields.iter() {
|
||||||
if f.attrs.len() == 0 {
|
if f.attrs.is_empty() {
|
||||||
field_names.push(f.ident.as_ref().unwrap().to_token_stream().to_string());
|
field_names.push(f.ident.as_ref().unwrap().to_token_stream().to_string());
|
||||||
} else {
|
} else {
|
||||||
f.attrs.iter().for_each(|attr| {
|
f.attrs.iter().for_each(|attr| {
|
||||||
|
|
@ -186,12 +187,10 @@ pub fn ros_point_derive(input: TokenStream) -> TokenStream {
|
||||||
impl ros_pointcloud2::PointConvertible<#field_len_token> for #name {}
|
impl ros_pointcloud2::PointConvertible<#field_len_token> for #name {}
|
||||||
};
|
};
|
||||||
|
|
||||||
let out = TokenStream::from(quote! {
|
TokenStream::from(quote! {
|
||||||
#field_impl
|
#field_impl
|
||||||
#from_my_point
|
#from_my_point
|
||||||
#from_custom_point
|
#from_custom_point
|
||||||
#convertible
|
#convertible
|
||||||
});
|
})
|
||||||
|
|
||||||
TokenStream::from(out)
|
|
||||||
}
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
[package]
|
||||||
|
name = "ros_pointcloud2"
|
||||||
|
version = "0.5.0-rc.1"
|
||||||
|
edition = "2021"
|
||||||
|
authors = ["Christopher Sieh <stelzo@steado.de>"]
|
||||||
|
description = "Customizable conversions for working with sensor_msgs/PointCloud2."
|
||||||
|
repository = "https://github.com/stelzo/ros_pointcloud2"
|
||||||
|
license = "MIT OR Apache-2.0"
|
||||||
|
keywords = ["ros", "pointcloud2", "pointcloud", "message"]
|
||||||
|
categories = [
|
||||||
|
"science::robotics",
|
||||||
|
"encoding",
|
||||||
|
"data-structures",
|
||||||
|
"api-bindings",
|
||||||
|
]
|
||||||
|
readme = "README.md"
|
||||||
|
documentation = "https://docs.rs/ros_pointcloud2"
|
||||||
|
homepage = "https://github.com/stelzo/ros_pointcloud2"
|
||||||
|
exclude = [
|
||||||
|
"**/.github/**",
|
||||||
|
"**/tests/**",
|
||||||
|
"**/examples/**",
|
||||||
|
"**/benches/**",
|
||||||
|
"**/target/**",
|
||||||
|
"**/build/**",
|
||||||
|
"**/dist/**",
|
||||||
|
"**/docs/**",
|
||||||
|
"**/doc/**",
|
||||||
|
]
|
||||||
|
rust-version = "1.63"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
rosrust_msg = { version = "0.1", optional = true }
|
||||||
|
rosrust = { version = "0.9.11", optional = true }
|
||||||
|
r2r = { version = "0.8.4", optional = true }
|
||||||
|
rayon = { version = "1", optional = true }
|
||||||
|
nalgebra = { version = "0.32.5", optional = true, default-features = false }
|
||||||
|
type-layout = { version = "0.2.0", package = "type-layout-syn2", optional = true }
|
||||||
|
rpcl2-derive = { version = "0.1.0", optional = true, path = "../rpcl2-derive" }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
rand = "0.8"
|
||||||
|
criterion = { version = "0.5", features = ["html_reports"] }
|
||||||
|
|
||||||
|
[[bench]]
|
||||||
|
name = "roundtrip"
|
||||||
|
harness = false
|
||||||
|
path = "benches/roundtrip.rs"
|
||||||
|
|
||||||
|
[features]
|
||||||
|
rosrust_msg = ["dep:rosrust_msg", "dep:rosrust"]
|
||||||
|
r2r_msg = ["dep:r2r"]
|
||||||
|
rayon = ["dep:rayon"]
|
||||||
|
derive = ["dep:rpcl2-derive", "dep:type-layout"]
|
||||||
|
nalgebra = ["dep:nalgebra"]
|
||||||
|
std = ["nalgebra/std"]
|
||||||
|
|
||||||
|
default = ["std", "derive"]
|
||||||
|
|
||||||
|
[package.metadata.docs.rs]
|
||||||
|
features = ["derive", "nalgebra", "rayon"]
|
||||||
|
default-target = "x86_64-unknown-linux-gnu"
|
||||||
|
rustdoc-args = ["--cfg", "docsrs"]
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
[package]
|
|
||||||
name = "rpcl2_derive"
|
|
||||||
version = "0.1.0"
|
|
||||||
edition = "2021"
|
|
||||||
|
|
||||||
[lib]
|
|
||||||
proc-macro = true
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
syn = "2.0"
|
|
||||||
quote = "1.0"
|
|
||||||
proc-macro2 = "1.0"
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
[package]
|
|
||||||
name = "type-layout"
|
|
||||||
description = "Derivable trait to view the layout of a struct, useful for debugging."
|
|
||||||
version = "0.2.0"
|
|
||||||
edition = "2018"
|
|
||||||
authors = ["Lucien Greathouse <me@lpghatguy.com>"]
|
|
||||||
documentation = "https://docs.rs/type-layout"
|
|
||||||
homepage = "https://github.com/LPGhatguy/type-layout"
|
|
||||||
repository = "https://github.com/LPGhatguy/type-layout"
|
|
||||||
readme = "README.md"
|
|
||||||
keywords = ["layout", "struct", "type"]
|
|
||||||
license = "MIT OR Apache-2.0"
|
|
||||||
rust-version = "1.60.0"
|
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
||||||
|
|
||||||
[features]
|
|
||||||
serde1 = ["serde"]
|
|
||||||
|
|
||||||
[workspace]
|
|
||||||
members = ["type-layout-derive", "try-crate"]
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
type-layout-derive = { version = "0.2.0", path = "type-layout-derive" }
|
|
||||||
|
|
||||||
memoffset = "0.9"
|
|
||||||
serde = { version = "1.0.116", features = ["derive"], optional = true }
|
|
||||||
|
|
@ -1,201 +0,0 @@
|
||||||
i 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.
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
Copyright (c) 2020 Lucien Greathouse
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
@ -1,204 +0,0 @@
|
||||||
/*!
|
|
||||||
[](https://github.com/LPGhatguy/type-layout/actions)
|
|
||||||
[](https://crates.io/crates/type-layout)
|
|
||||||
[](https://docs.rs/type-layout)
|
|
||||||
|
|
||||||
type-layout is a type layout debugging aid, providing a `#[derive]`able trait
|
|
||||||
that reports:
|
|
||||||
- The type's name, size, and minimum alignment
|
|
||||||
- Each field's name, type, offset, and size
|
|
||||||
- Padding due to alignment requirements
|
|
||||||
|
|
||||||
**type-layout currently only functions on structs with named fields.** This is a
|
|
||||||
temporary limitation.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
The layout of types is only defined if they're `#[repr(C)]`. This crate works on
|
|
||||||
non-`#[repr(C)]` types, but their layout is unpredictable.
|
|
||||||
|
|
||||||
```rust
|
|
||||||
use type_layout::TypeLayout;
|
|
||||||
|
|
||||||
#[derive(TypeLayout)]
|
|
||||||
#[repr(C)]
|
|
||||||
struct Foo {
|
|
||||||
a: u8,
|
|
||||||
b: u32,
|
|
||||||
}
|
|
||||||
|
|
||||||
println!("{}", Foo::type_layout());
|
|
||||||
// prints:
|
|
||||||
// Foo (size 8, alignment 4)
|
|
||||||
// | Offset | Name | Size |
|
|
||||||
// | ------ | --------- | ---- |
|
|
||||||
// | 0 | a | 1 |
|
|
||||||
// | 1 | [padding] | 3 |
|
|
||||||
// | 4 | b | 4 |
|
|
||||||
```
|
|
||||||
|
|
||||||
Over-aligned types have trailing padding, which can be a source of bugs in some
|
|
||||||
FFI scenarios:
|
|
||||||
|
|
||||||
```rust
|
|
||||||
use type_layout::TypeLayout;
|
|
||||||
|
|
||||||
#[derive(TypeLayout)]
|
|
||||||
#[repr(C, align(128))]
|
|
||||||
struct OverAligned {
|
|
||||||
value: u8,
|
|
||||||
}
|
|
||||||
|
|
||||||
println!("{}", OverAligned::type_layout());
|
|
||||||
// prints:
|
|
||||||
// OverAligned (size 128, alignment 128)
|
|
||||||
// | Offset | Name | Size |
|
|
||||||
// | ------ | --------- | ---- |
|
|
||||||
// | 0 | value | 1 |
|
|
||||||
// | 1 | [padding] | 127 |
|
|
||||||
```
|
|
||||||
|
|
||||||
## Minimum Supported Rust Version (MSRV)
|
|
||||||
|
|
||||||
type-layout supports Rust 1.34.1 and newer. Until type-layout reaches 1.0,
|
|
||||||
changes to the MSRV will require major version bumps. After 1.0, MSRV changes
|
|
||||||
will only require minor version bumps, but will need significant justification.
|
|
||||||
*/
|
|
||||||
|
|
||||||
use std::borrow::Cow;
|
|
||||||
use std::fmt::{self, Display};
|
|
||||||
use std::str;
|
|
||||||
|
|
||||||
pub use type_layout_derive::TypeLayout;
|
|
||||||
|
|
||||||
#[doc(hidden)]
|
|
||||||
pub use memoffset;
|
|
||||||
|
|
||||||
pub trait TypeLayout {
|
|
||||||
fn type_layout() -> TypeLayoutInfo;
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
pub struct TypeLayoutInfo {
|
|
||||||
pub name: Cow<'static, str>,
|
|
||||||
pub size: usize,
|
|
||||||
pub alignment: usize,
|
|
||||||
pub fields: Vec<Field>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
pub enum Field {
|
|
||||||
Field {
|
|
||||||
name: Cow<'static, str>,
|
|
||||||
ty: Cow<'static, str>,
|
|
||||||
size: usize,
|
|
||||||
},
|
|
||||||
Padding {
|
|
||||||
size: usize,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
impl fmt::Display for TypeLayoutInfo {
|
|
||||||
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
|
|
||||||
writeln!(
|
|
||||||
formatter,
|
|
||||||
"{} (size {}, alignment {})",
|
|
||||||
self.name, self.size, self.alignment
|
|
||||||
)?;
|
|
||||||
|
|
||||||
let longest_name = self
|
|
||||||
.fields
|
|
||||||
.iter()
|
|
||||||
.map(|field| match field {
|
|
||||||
Field::Field { name, .. } => name.len(),
|
|
||||||
Field::Padding { .. } => "[padding]".len(),
|
|
||||||
})
|
|
||||||
.max()
|
|
||||||
.unwrap_or(1);
|
|
||||||
|
|
||||||
let widths = RowWidths {
|
|
||||||
offset: "Offset".len(),
|
|
||||||
name: longest_name,
|
|
||||||
size: "Size".len(),
|
|
||||||
};
|
|
||||||
|
|
||||||
write_row(
|
|
||||||
formatter,
|
|
||||||
widths,
|
|
||||||
Row {
|
|
||||||
offset: "Offset",
|
|
||||||
name: "Name",
|
|
||||||
size: "Size",
|
|
||||||
},
|
|
||||||
)?;
|
|
||||||
|
|
||||||
write_row(
|
|
||||||
formatter,
|
|
||||||
widths,
|
|
||||||
Row {
|
|
||||||
offset: "------",
|
|
||||||
name: str::repeat("-", longest_name),
|
|
||||||
size: "----",
|
|
||||||
},
|
|
||||||
)?;
|
|
||||||
|
|
||||||
let mut offset = 0;
|
|
||||||
|
|
||||||
for field in &self.fields {
|
|
||||||
match field {
|
|
||||||
Field::Field { name, size, .. } => {
|
|
||||||
write_row(formatter, widths, Row { offset, name, size })?;
|
|
||||||
|
|
||||||
offset += size;
|
|
||||||
}
|
|
||||||
Field::Padding { size } => {
|
|
||||||
write_row(
|
|
||||||
formatter,
|
|
||||||
widths,
|
|
||||||
Row {
|
|
||||||
offset,
|
|
||||||
name: "[padding]",
|
|
||||||
size,
|
|
||||||
},
|
|
||||||
)?;
|
|
||||||
|
|
||||||
offset += size;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone, Copy)]
|
|
||||||
struct RowWidths {
|
|
||||||
offset: usize,
|
|
||||||
name: usize,
|
|
||||||
size: usize,
|
|
||||||
}
|
|
||||||
|
|
||||||
struct Row<O, N, S> {
|
|
||||||
offset: O,
|
|
||||||
name: N,
|
|
||||||
size: S,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn write_row<O: Display, N: Display, S: Display>(
|
|
||||||
formatter: &mut fmt::Formatter,
|
|
||||||
widths: RowWidths,
|
|
||||||
row: Row<O, N, S>,
|
|
||||||
) -> fmt::Result {
|
|
||||||
writeln!(
|
|
||||||
formatter,
|
|
||||||
"| {:<offset_width$} | {:<name_width$} | {:<size_width$} |",
|
|
||||||
row.offset,
|
|
||||||
row.name,
|
|
||||||
row.size,
|
|
||||||
offset_width = widths.offset,
|
|
||||||
name_width = widths.name,
|
|
||||||
size_width = widths.size
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
[package]
|
|
||||||
name = "type-layout-derive"
|
|
||||||
description = "Derive macro implementation for type-layout crate"
|
|
||||||
version = "0.2.0"
|
|
||||||
edition = "2018"
|
|
||||||
authors = ["Lucien Greathouse <me@lpghatguy.com>"]
|
|
||||||
homepage = "https://github.com/LPGhatguy/type-layout"
|
|
||||||
license = "MIT OR Apache-2.0"
|
|
||||||
|
|
||||||
[lib]
|
|
||||||
proc-macro = true
|
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
syn = "2"
|
|
||||||
quote = "1.0.7"
|
|
||||||
proc-macro2 = "1.0.21"
|
|
||||||
|
|
@ -1,93 +0,0 @@
|
||||||
extern crate proc_macro;
|
|
||||||
|
|
||||||
use proc_macro::TokenStream;
|
|
||||||
|
|
||||||
use proc_macro2::{Ident, Literal};
|
|
||||||
use quote::{quote, quote_spanned, ToTokens};
|
|
||||||
use syn::{parse_macro_input, spanned::Spanned, Data, DeriveInput, Fields};
|
|
||||||
|
|
||||||
#[proc_macro_derive(TypeLayout)]
|
|
||||||
pub fn derive_type_layout(input: TokenStream) -> TokenStream {
|
|
||||||
// Parse the input tokens into a syntax tree
|
|
||||||
let input = parse_macro_input!(input as DeriveInput);
|
|
||||||
|
|
||||||
// Used in the quasi-quotation below as `#name`.
|
|
||||||
let name = input.ident;
|
|
||||||
let name_str = Literal::string(&name.to_string());
|
|
||||||
|
|
||||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
|
||||||
let layout = layout_of_type(&name, &input.data);
|
|
||||||
|
|
||||||
// Build the output, possibly using quasi-quotation
|
|
||||||
let expanded = quote! {
|
|
||||||
impl #impl_generics ::type_layout::TypeLayout for #name #ty_generics #where_clause {
|
|
||||||
fn type_layout() -> ::type_layout::TypeLayoutInfo {
|
|
||||||
let mut last_field_end = 0;
|
|
||||||
let mut fields = Vec::new();
|
|
||||||
|
|
||||||
#layout
|
|
||||||
|
|
||||||
::type_layout::TypeLayoutInfo {
|
|
||||||
name: ::std::borrow::Cow::Borrowed(#name_str),
|
|
||||||
size: std::mem::size_of::<#name>(),
|
|
||||||
alignment: ::std::mem::align_of::<#name>(),
|
|
||||||
fields,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Hand the output tokens back to the compiler
|
|
||||||
TokenStream::from(expanded)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn layout_of_type(struct_name: &Ident, data: &Data) -> proc_macro2::TokenStream {
|
|
||||||
match data {
|
|
||||||
Data::Struct(data) => match &data.fields {
|
|
||||||
Fields::Named(fields) => {
|
|
||||||
let values = fields.named.iter().map(|field| {
|
|
||||||
let field_name = field.ident.as_ref().unwrap();
|
|
||||||
let field_name_str = Literal::string(&field_name.to_string());
|
|
||||||
let field_ty = &field.ty;
|
|
||||||
let field_ty_str = Literal::string(&field_ty.to_token_stream().to_string());
|
|
||||||
|
|
||||||
quote_spanned! { field.span() =>
|
|
||||||
#[allow(unused_assignments)]
|
|
||||||
{
|
|
||||||
let size = ::std::mem::size_of::<#field_ty>();
|
|
||||||
let offset = ::type_layout::memoffset::offset_of!(#struct_name, #field_name);
|
|
||||||
|
|
||||||
if offset > last_field_end {
|
|
||||||
fields.push(::type_layout::Field::Padding {
|
|
||||||
size: offset - last_field_end
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
fields.push(::type_layout::Field::Field {
|
|
||||||
name: ::std::borrow::Cow::Borrowed(#field_name_str),
|
|
||||||
ty: ::std::borrow::Cow::Borrowed(#field_ty_str),
|
|
||||||
size,
|
|
||||||
});
|
|
||||||
|
|
||||||
last_field_end = offset + size;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
quote! {
|
|
||||||
#(#values)*
|
|
||||||
|
|
||||||
let struct_size = ::std::mem::size_of::<#struct_name>();
|
|
||||||
if struct_size > last_field_end {
|
|
||||||
fields.push(::type_layout::Field::Padding {
|
|
||||||
size: struct_size - last_field_end,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Fields::Unnamed(_) => unimplemented!(),
|
|
||||||
Fields::Unit => unimplemented!(),
|
|
||||||
},
|
|
||||||
Data::Enum(_) | Data::Union(_) => unimplemented!("type-layout only supports structs"),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in New Issue