diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..290afab --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target/ +*~ +**/*.rs.bk +Cargo.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..930f0bd --- /dev/null +++ b/.travis.yml @@ -0,0 +1,11 @@ +language: rust +rust: + - stable + - nightly +script: + - cargo build + - | + if [ $TRAVIS_RUST_VERSION == nightly ]; then + cargo test --verbose --all + fi + diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..044fbfe --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "typename" +version = "0.1.0" +authors = ["Sebastian Wicki "] +license = "MIT/Apache-2.0" +repository = "https://github.com/strymon-system/typename" +documentation = "https://docs.rs/typename" +description = "Stable alternative to Rust's type_name intrinsic." + +[dependencies.typename_derive] +optional = true +version = "0.1.0" +path = "./typename_derive" + +[features] +default = ["derive"] +derive = ["typename_derive"] + +[workspace] +members = ["typename_derive"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /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..2093d37 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2017 ETH Zurich. + +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..5b2c7eb --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +typename +======== + +[![Build Status](https://travis-ci.org/strymon-system/typename.svg?branch=master)](https://travis-ci.org/strymon-system/typename) +[![Latest Version](https://img.shields.io/crates/v/typename.svg)](https://crates.io/crates/typename) +[![Documentation](https://docs.rs/typename/badge.svg)](https://docs.rs/typename) + +A compatible, safe and stable alternative to Rust's +[`std::intrinsics::type_name`](https://doc.rust-lang.org/std/intrinsics/fn.type_name.html) +intrinsic. + +# Example + +```rust +extern crate typename; + +use typename::TypeName; + +fn main() { + assert_eq!(String::type_name(), "std::string::String"); + assert_eq!(Vec::::type_name(), "std::vec::Vec"); + assert_eq!([0, 1, 2].type_name_of(), "[i32; 3]"); +} +``` + +## Contribute + +`typename` is part of the [Strymon](https://strymon-system.github.io/) project: + + - [Contribution Guide](https://strymon-system.github.io/docs/how-to-contribute) + - [Mailing list](https://lists.inf.ethz.ch/mailman/listinfo/strymon-users) + +## License + +`typename` is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses. + +See LICENSE-APACHE, and LICENSE-MIT for details. diff --git a/examples/derive.rs b/examples/derive.rs new file mode 100644 index 0000000..5793627 --- /dev/null +++ b/examples/derive.rs @@ -0,0 +1,26 @@ +// Copyright 2017 ETH Zurich. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +#[macro_use] +extern crate typename; + +use typename::TypeName; + +#[derive(TypeName)] +struct Custom { + _t: T, +} + +fn main() { + assert_eq!( + Custom::::type_name(), + concat!(module_path!(), "::", "Custom") + ); + let c = Custom { _t: 3.14 }; + println!("{}", c.type_name_of()); +} diff --git a/src/fmt.rs b/src/fmt.rs new file mode 100644 index 0000000..229dca7 --- /dev/null +++ b/src/fmt.rs @@ -0,0 +1,85 @@ +// Copyright 2017 ETH Zurich. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! Hidden support module for formatting type names of the form +//! `some::path::Name`. It will omit printing angle brackets +//! if no generic type parameters are provided. +//! +//! # Examples +//! +//! ``` +//! use typename::{fmt, TypeName}; +//! +//! struct Foo { +//! some_t: T, +//! some_u: U, +//! } +//! +//! impl TypeName for Foo { +//! fn fmt(f: &mut ::std::fmt::Formatter) -> std::fmt::Result { +//! typename::fmt::TypeFormatter::new(f, concat!(module_path!(), "::Foo")) +//! .type_param::() +//! .type_param::() +//! .finish() +//! } +//! } +//! +//! fn main() { +//! assert_eq!(Foo::::type_name(), concat!(module_path!(), "::Foo")); +//! } +//! ``` +use std::fmt; + +use super::TypeName; + +/// A builder struct for formatting type names. +/// +/// It's interface is very similar to the debug buildes in `std::fmt`, e.g. +/// `DebugTuple`. +pub struct TypeFormatter<'a, 'b: 'a> { + fmt: &'a mut fmt::Formatter<'b>, + result: fmt::Result, + has_params: bool, +} + +impl<'a, 'b: 'a> TypeFormatter<'a, 'b> { + /// Create a new builder which eagerliy writes to the provided + /// `Formatter`. + pub fn new(fmt: &'a mut fmt::Formatter<'b>, name: &str) -> Self { + let result = fmt.write_str(name); + TypeFormatter { + fmt, + result, + has_params: false, + } + } + + /// Attaches the type name of the provided type argument to the type name. + pub fn type_param(&mut self) -> &mut Self { + self.result = self.result.and_then(|_| { + if self.has_params { + self.fmt.write_str(", ")? + } else { + self.fmt.write_str("<")? + }; + + ::fmt(self.fmt) + }); + + self.has_params = true; + self + } + + /// Finishes output and returns any error encountered. + pub fn finish(&mut self) -> fmt::Result { + if self.has_params { + self.result = self.result.and_then(|_| self.fmt.write_str(">")); + } + self.result + } +} diff --git a/src/imp.rs b/src/imp.rs new file mode 100644 index 0000000..6ebc8cf --- /dev/null +++ b/src/imp.rs @@ -0,0 +1,246 @@ +// Copyright 2017 ETH Zurich. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! This module contains all the implementations of `TypeName` for the +//! different types found in `std`. +use std; + +macro_rules! derive_type_name { + ( $prefix:ident $(:: $suffix:ident)* $(<$($ty_param:ident),+>)*) => { + impl$(<$($ty_param: $crate::TypeName),*>)* $crate::TypeName + for $prefix $(:: $suffix)* $(<$($ty_param),*>)* + { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + let _ty_name = concat!(stringify!($prefix), $("::", stringify!($suffix)),*); + $crate::fmt::TypeFormatter::new(fmt, _ty_name) + $( $(.type_param::<$ty_param>() )* )* + .finish() + } + } + } +} + +macro_rules! derive_tuple_type_name { + ( $head:ident, $($tail:ident),+ ) => { + impl<$head: $crate::TypeName, $($tail: $crate::TypeName),+> + $crate::TypeName + for ( $head, $($tail,)+ ) + { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + fmt.write_str("(")?; + $head::fmt(fmt)?; + $( + fmt.write_str(", ")?; + $tail::fmt(fmt)?; + )+ + fmt.write_str(")") + } + } + } +} + +macro_rules! derive_array_type_name { + ($size:expr) => { + impl $crate::TypeName for [T; $size] { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + fmt.write_str("[")?; + T::fmt(fmt)?; + fmt.write_str(concat!("; ", $size, "]")) + } + } + } +} + +derive_type_name!(u8); +derive_type_name!(u16); +derive_type_name!(u32); +derive_type_name!(u64); +derive_type_name!(usize); + +derive_type_name!(i8); +derive_type_name!(i16); +derive_type_name!(i32); +derive_type_name!(i64); +derive_type_name!(isize); + +derive_type_name!(f32); +derive_type_name!(f64); + +derive_type_name!(char); +derive_type_name!(bool); +derive_type_name!(str); + +impl<'a, T: ::TypeName> ::TypeName for &'a T { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + fmt.write_str("&")?; + T::fmt(fmt) + } +} + +impl<'a, T: ::TypeName> ::TypeName for &'a mut T { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + fmt.write_str("&mut ")?; + T::fmt(fmt) + } +} + +derive_type_name!(std::string::String); +derive_type_name!(std::marker::PhantomData); +derive_type_name!(std::vec::Vec); +derive_type_name!(std::boxed::Box); +derive_type_name!(std::option::Option); +derive_type_name!(std::result::Result); +derive_type_name!(std::rc::Rc); + +// the empty and singleton tuple are special cases +impl ::TypeName for () { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + fmt.write_str("()") + } +} + +impl ::TypeName for (A,) { + fn fmt(fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + fmt.write_str("(")?; + A::fmt(fmt)?; + fmt.write_str(",)") + } +} + +derive_tuple_type_name!(A, B); +derive_tuple_type_name!(A, B, C); +derive_tuple_type_name!(A, B, C, D); +derive_tuple_type_name!(A, B, C, D, E); +derive_tuple_type_name!(A, B, C, D, E, F); +derive_tuple_type_name!(A, B, C, D, E, F, G); +derive_tuple_type_name!(A, B, C, D, E, F, G, H); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, AA); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, AA, AB); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, AA, AB, AC); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, AA, AB, AC, AD); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, AA, AB, AC, AD, AE); +derive_tuple_type_name!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, AA, AB, AC, AD, AE, AF); + +derive_array_type_name!(0); +derive_array_type_name!(1); +derive_array_type_name!(2); +derive_array_type_name!(3); +derive_array_type_name!(4); +derive_array_type_name!(5); +derive_array_type_name!(6); +derive_array_type_name!(7); +derive_array_type_name!(8); +derive_array_type_name!(9); +derive_array_type_name!(10); +derive_array_type_name!(11); +derive_array_type_name!(12); +derive_array_type_name!(13); +derive_array_type_name!(14); +derive_array_type_name!(15); +derive_array_type_name!(16); +derive_array_type_name!(17); +derive_array_type_name!(18); +derive_array_type_name!(19); +derive_array_type_name!(20); +derive_array_type_name!(21); +derive_array_type_name!(22); +derive_array_type_name!(23); +derive_array_type_name!(24); +derive_array_type_name!(25); +derive_array_type_name!(26); +derive_array_type_name!(27); +derive_array_type_name!(28); +derive_array_type_name!(29); +derive_array_type_name!(30); +derive_array_type_name!(31); +derive_array_type_name!(32); + +#[cfg(test)] +mod tests { + use TypeName; + use std::intrinsics::type_name; + + fn assert_eq_name() { + assert_eq!(unsafe { type_name::() }, T::type_name()); + } + + #[test] + fn primitive_types() { + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::(); + + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::(); + + assert_eq_name::(); + assert_eq_name::(); + + assert_eq_name::(); + assert_eq_name::(); + assert_eq_name::<()>(); + } + + + #[test] + fn array_types() { + assert_eq_name::<[i32; 0]>(); + assert_eq_name::<[bool; 4]>(); + assert_eq_name::<[(char, i32); 10]>(); + assert_eq_name::<&mut [usize; 32]>(); + } + + #[test] + fn ref_types() { + assert_eq_name::<&u8>(); + assert_eq_name::<&mut i32>(); + // FIXME(swicki): DSTs currently don't work + //assert_eq_name::<&str>(); + //assert_eq_name::<&mut [T]>(); + } + + #[test] + fn tuples_types() { + assert_eq_name::<(i32,)>(); + assert_eq_name::<(i32, i32)>(); + assert_eq_name::<(i32, f32, u8)>(); + assert_eq_name::<(i8, i8, i8, i8, i8, i8, i8, i8, i8, i8, i8)>(); + } + + #[test] + fn std_types() { + assert_eq_name::>(); + assert_eq_name::>(); + assert_eq_name::<&mut Box>>(); + assert_eq_name::<[::std::rc::Rc; 5]>(); + assert_eq_name::<::std::marker::PhantomData<&i32>>(); + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..dbd7961 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,117 @@ +// Copyright 2017 ETH Zurich. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! This crate provides a compatible, safe and stable alternative to Rust's +//! [`std::intrinsics::type_name`](https://doc.rust-lang.org/std/intrinsics/fn.type_name.html) +//! intrinsic. This is achieved through the [`TypeName`](trait.TypeName.html) +//! trait which is implemented for most types in `std` and can be implemented +//! manually for custom types. +//! +//! This crate also exposes a procedural macro to automatically derive the +//! trait using `#[derive(TypeName)]`. This is an optional dependency which can +//! be disabled by opting out from the `derive` feature in Cargo. +//! +//! # Examples +//! +//! ``` +//! use typename::TypeName; +//! +//! fn main() { +//! assert_eq!(String::type_name(), "std::string::String"); +//! assert_eq!(Vec::::type_name(), "std::vec::Vec"); +//! assert_eq!([0, 1, 2].type_name_of(), "[i32; 3]"); +//! } +//! ``` +//! +//! You can derive the `TypeName` trait for custom types as follows: +//! +//! ```rust,ignore +//! #[macro_use] extern crate typename; +//! +//! #[derive(TypeName)] +//! struct Custom { +//! some_t: T, +//! } +//! ``` +//! # Prior work +//! +//! This crate is inspired by the [`named_type`](https://docs.rs/named_type) crate +//! which provides a similar interface. However, its output is not compatible with +//! the `type_name` intrinsic, as its name does not contain the names of the +//! concrete instanstances of the type parameters. + +#![cfg_attr(test, feature(test, core_intrinsics))] + +#[warn(missing_docs)] +#[cfg(feature = "derive")] +#[allow(unused_imports)] +#[macro_use] +extern crate typename_derive; +#[cfg(feature = "derive")] +#[doc(hidden)] +pub use typename_derive::*; + +use std::marker::PhantomData; + +mod imp; +#[doc(hidden)] +pub mod fmt; + +/// Trait which returns the canonical name of the implementing type. +/// +/// ## Derivable +/// +/// This trait can be used with `#[derive(TypeName)]`. Any generic parameters +/// to a type must implement `TypeName` as well. +/// +/// ## How can I implement `TypeName`? +/// +/// `TypeName` requires that the `fmt` function formats the type name exactly +/// the same way as returned by the +/// [`std::intrinsics::type_name`](https://doc.rust-lang.org/std/intrinsics/fn.type_name.html) +/// intrinsic. It requires that the name contains the fully qualified path to the type +/// (which can be obtained through the `module_path!()` macro), as well as +/// the concrete values of its generic parameters. +pub trait TypeName { + /// Formats the fully qualified type name using the given formatter. + fn fmt(f: &mut std::fmt::Formatter) -> std::fmt::Result; + + /// Returns the canoncial, concrete name of a type as a string. + /// # Examples + /// + /// ``` + /// use typename::TypeName; + /// + /// assert_eq!(String::type_name(), "std::string::String"); + /// ``` + fn type_name() -> String { + DisplayType::(PhantomData).to_string() + } + + /// Returns the canoncial type of a value as a string. + /// # Examples + /// + /// ``` + /// use typename::TypeName; + /// + /// assert_eq!(vec![0, 1, 2].type_name_of(), "std::vec::Vec"); + /// ``` + fn type_name_of(&self) -> String { + Self::type_name() + } +} + +/// Wrapper type which implements `Display` to call into `TypeName` +struct DisplayType(PhantomData); + +/// A `Display` impl is probably the easiest way to format into a `String` +impl std::fmt::Display for DisplayType { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + ::fmt(f) + } +} diff --git a/typename_derive/Cargo.toml b/typename_derive/Cargo.toml new file mode 100644 index 0000000..877da25 --- /dev/null +++ b/typename_derive/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "typename_derive" +version = "0.1.0" +authors = ["Sebastian Wicki "] +license = "MIT/Apache-2.0" +repository = "https://github.com/strymon-system/typename" +documentation = "https://docs.rs/typename_derive" + +[lib] +name = "typename_derive" +proc-macro = true + +[dependencies] +syn = "0.11" +quote = "0.3" + +[dev-dependencies.typename] +path = ".." +version = "0.1.0" +default-features = false diff --git a/typename_derive/LICENSE-APACHE b/typename_derive/LICENSE-APACHE new file mode 120000 index 0000000..965b606 --- /dev/null +++ b/typename_derive/LICENSE-APACHE @@ -0,0 +1 @@ +../LICENSE-APACHE \ No newline at end of file diff --git a/typename_derive/LICENSE-MIT b/typename_derive/LICENSE-MIT new file mode 120000 index 0000000..76219eb --- /dev/null +++ b/typename_derive/LICENSE-MIT @@ -0,0 +1 @@ +../LICENSE-MIT \ No newline at end of file diff --git a/typename_derive/src/lib.rs b/typename_derive/src/lib.rs new file mode 100644 index 0000000..21b9e1b --- /dev/null +++ b/typename_derive/src/lib.rs @@ -0,0 +1,59 @@ +// Copyright 2017 ETH Zurich. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! Procedural macro for deriving the `TypeName` trait. +//! +//! # Examples +//! +//! ```rust,ignore +//! use typename::TypeName; +//! +//! #[derive(TypeName)] +//! struct Custom { +//! some_t: T, +//! } +//! +//! fn main() { +//! assert_eq!(Custom::::type_name(), concat!(module_path!(), "::", "Custom")); +//! } + +extern crate proc_macro; + +extern crate syn; +#[macro_use] +extern crate quote; + +use proc_macro::TokenStream; + +#[doc(hidden)] +#[proc_macro_derive(TypeName)] +pub fn derive_topic_type(input: TokenStream) -> TokenStream { + let source = input.to_string(); + let ast = syn::parse_derive_input(&source).unwrap(); + let expanded = impl_topic_type(&ast); + expanded.parse().unwrap() +} + +fn impl_topic_type(ast: &syn::DeriveInput) -> quote::Tokens { + let name = &ast.ident; + let ty_params = ast.generics.ty_params.iter().map(|p| &p.ident); + let (impl_generics, ty_generics, where_clause) = ast.generics.split_for_impl(); + + quote! { + impl #impl_generics ::typename::TypeName for #name #ty_generics #where_clause { + fn fmt(f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + let _ty_name = concat!(module_path!(), "::", stringify!(#name)); + ::typename::fmt::TypeFormatter::new(f, _ty_name) + #( + .type_param::< #ty_params >() + )* + .finish() + } + } + } +} diff --git a/typename_derive/tests/tests.rs b/typename_derive/tests/tests.rs new file mode 100644 index 0000000..86bb059 --- /dev/null +++ b/typename_derive/tests/tests.rs @@ -0,0 +1,45 @@ +// Copyright 2017 ETH Zurich. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +#[macro_use] +extern crate typename_derive; +extern crate typename; + +use typename::TypeName; + +#[derive(TypeName)] +struct UnitStruct; + +#[derive(TypeName)] +enum SomeEnum { + _A, + _B, +} + +#[derive(TypeName)] +struct TupleStruct(T); + +#[derive(TypeName)] +struct Struct { + _t: T, + _s: S, +} + +#[test] +fn check_type_name() { + assert_eq!("tests::UnitStruct", UnitStruct::type_name()); + assert_eq!( + "tests::TupleStruct", + TupleStruct::::type_name() + ); + assert_eq!( + "tests::Struct", + Struct::::type_name() + ); + assert_eq!("tests::SomeEnum", SomeEnum::type_name()); +}