diff --git a/.github/workflows/hex-literal.yml b/.github/workflows/hex-literal.yml index 0d65e5fb..0eecb706 100644 --- a/.github/workflows/hex-literal.yml +++ b/.github/workflows/hex-literal.yml @@ -22,7 +22,7 @@ jobs: strategy: matrix: rust: - - 1.41.0 # MSRV + - 1.45.0 # MSRV - stable target: - thumbv7em-none-eabi @@ -41,7 +41,7 @@ jobs: strategy: matrix: rust: - - 1.41.0 # MSRV + - 1.45.0 # MSRV - stable steps: - uses: actions/checkout@v1 @@ -49,4 +49,5 @@ jobs: with: profile: minimal toolchain: ${{ matrix.rust }} + override: true - run: cargo test --release diff --git a/Cargo.lock b/Cargo.lock index 5a0b9c64..686bf2b9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -52,29 +52,12 @@ checksum = "805026a5d0141ffc30abb3be3173848ad46a1b1664fe632428479619a3644d77" [[package]] name = "hex-literal" -version = "0.2.1" -dependencies = [ - "hex-literal-impl", - "proc-macro-hack", -] - -[[package]] -name = "hex-literal-impl" -version = "0.2.2" -dependencies = [ - "proc-macro-hack", -] +version = "0.3.0" [[package]] name = "opaque-debug" version = "0.3.0" -[[package]] -name = "proc-macro-hack" -version = "0.5.16" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e0456befd48169b9f13ef0f0ad46d492cf9d2dbb918bcf38e01eed4ce3ec5e4" - [[package]] name = "typenum" version = "1.12.0" diff --git a/Cargo.toml b/Cargo.toml index 60448eae..b5762861 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,6 +7,5 @@ members = [ "cpuid-bool", "dbl", "hex-literal", - "hex-literal/hex-literal-impl", "opaque-debug", ] diff --git a/hex-literal/Cargo.toml b/hex-literal/Cargo.toml index f8760a9d..7490b784 100644 --- a/hex-literal/Cargo.toml +++ b/hex-literal/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "hex-literal" -version = "0.2.1" +version = "0.3.0" authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" description = "Procedural macro for converting hexadecimal string to byte array at compile time." @@ -9,6 +9,5 @@ repository = "https://github.com/RustCrypto/utils" keywords = ["hex", "proc-macro", "literals"] edition = "2018" -[dependencies] -proc-macro-hack = "0.5" -hex-literal-impl = { version = "0.2", path = "./hex-literal-impl" } +[lib] +proc-macro = true diff --git a/hex-literal/hex-literal-impl/Cargo.toml b/hex-literal/hex-literal-impl/Cargo.toml deleted file mode 100644 index 6f7ca08a..00000000 --- a/hex-literal/hex-literal-impl/Cargo.toml +++ /dev/null @@ -1,15 +0,0 @@ -[package] -name = "hex-literal-impl" -version = "0.2.2" -authors = ["RustCrypto Developers"] -license = "MIT OR Apache-2.0" -description = "Internal implementation of the hex-literal crate" -repository = "https://github.com/RustCrypto/utils" -edition = "2018" - -[dependencies] -proc-macro-hack = "0.5" - -[lib] -proc-macro = true - diff --git a/hex-literal/hex-literal-impl/LICENSE-APACHE b/hex-literal/hex-literal-impl/LICENSE-APACHE deleted file mode 100644 index 78173fa2..00000000 --- a/hex-literal/hex-literal-impl/LICENSE-APACHE +++ /dev/null @@ -1,201 +0,0 @@ - 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/hex-literal/hex-literal-impl/LICENSE-MIT b/hex-literal/hex-literal-impl/LICENSE-MIT deleted file mode 100644 index b03ace94..00000000 --- a/hex-literal/hex-literal-impl/LICENSE-MIT +++ /dev/null @@ -1,26 +0,0 @@ -Copyright (c) 2018 Artyom Pavlov -Copyright (c) 2018 The RustCrypto Project Developers - -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/hex-literal/hex-literal-impl/src/lib.rs b/hex-literal/hex-literal-impl/src/lib.rs deleted file mode 100644 index 6732264e..00000000 --- a/hex-literal/hex-literal-impl/src/lib.rs +++ /dev/null @@ -1,76 +0,0 @@ -extern crate proc_macro; - -use proc_macro::{Delimiter, TokenStream, TokenTree}; -use proc_macro_hack::proc_macro_hack; - -fn is_hex_char(c: &char) -> bool { - match *c { - '0'..='9' | 'a'..='f' | 'A'..='F' => true, - _ => false, - } -} - -fn is_format_char(c: &char) -> bool { - match *c { - ' ' | '\r' | '\n' | '\t' => true, - _ => false, - } -} - -/// Strips any outer `Delimiter::None` groups from the input, -/// returning a `TokenStream` consisting of the innermost -/// non-empty-group `TokenTree`. -/// This is used to handle a proc macro being invoked -/// by a `macro_rules!` expansion. -/// See https://github.com/rust-lang/rust/issues/72545 for background -fn ignore_groups(mut input: TokenStream) -> TokenStream { - let mut tokens = input.clone().into_iter(); - loop { - if let Some(TokenTree::Group(group)) = tokens.next() { - if group.delimiter() == Delimiter::None { - input = group.stream(); - continue; - } - } - return input; - } -} - -#[proc_macro_hack] -pub fn hex(mut input: TokenStream) -> TokenStream { - input = ignore_groups(input); - let mut ts = input.into_iter(); - let input = match (ts.next(), ts.next()) { - (Some(TokenTree::Literal(literal)), None) => literal.to_string(), - _ => panic!("expected one string literal"), - }; - - let bytes = input.as_bytes(); - let n = bytes.len(); - // trim quote characters - let input = &input[1..n - 1]; - - for (i, c) in input.chars().enumerate() { - if !(is_hex_char(&c) || is_format_char(&c)) { - panic!("invalid character (position {}): {:?})", i + 1, c); - } - } - let n = input.chars().filter(is_hex_char).count() / 2; - let mut s = String::with_capacity(2 + 7 * n); - - s.push('['); - let mut iter = input.chars().filter(is_hex_char); - while let Some(c1) = iter.next() { - if let Some(c2) = iter.next() { - s += "0x"; - s.push(c1); - s.push(c2); - s += "u8,"; - } else { - panic!("expected even number of hex characters"); - } - } - s.push(']'); - - s.parse().unwrap() -} diff --git a/hex-literal/src/lib.rs b/hex-literal/src/lib.rs index 1a086796..52de8ba2 100644 --- a/hex-literal/src/lib.rs +++ b/hex-literal/src/lib.rs @@ -26,9 +26,99 @@ //! # } //! ``` #![doc(html_logo_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo_small.png")] -#![no_std] -#[doc(hidden)] -#[proc_macro_hack] -pub use hex_literal_impl::hex; -use proc_macro_hack::proc_macro_hack; +extern crate proc_macro; + +use proc_macro::{Delimiter, Group, Literal, Punct, Spacing, TokenStream, TokenTree}; +use std::iter::FromIterator; + +/// Strips any outer `Delimiter::None` groups from the input, +/// returning a `TokenStream` consisting of the innermost +/// non-empty-group `TokenTree`. +/// This is used to handle a proc macro being invoked +/// by a `macro_rules!` expansion. +/// See https://github.com/rust-lang/rust/issues/72545 for background +fn ignore_groups(mut input: TokenStream) -> TokenStream { + let mut tokens = input.clone().into_iter(); + loop { + if let Some(TokenTree::Group(group)) = tokens.next() { + if group.delimiter() == Delimiter::None { + input = group.stream(); + continue; + } + } + return input; + } +} + +struct TokenTreeIter { + buf: Vec, + pos: usize, + is_punct: bool, +} + +impl TokenTreeIter { + fn new(input: TokenStream) -> Self { + let mut ts = ignore_groups(input).into_iter(); + let input_str = match (ts.next(), ts.next()) { + (Some(TokenTree::Literal(literal)), None) => literal.to_string(), + _ => panic!("expected single string literal"), + }; + let mut buf: Vec = input_str.into(); + + match buf.as_slice() { + [b'"', .., b'"'] => (), + _ => panic!("expected single string literal"), + }; + buf.pop(); + Self { + buf, + pos: 1, + is_punct: false, + } + } + + fn next_hex_val(&mut self) -> Option { + loop { + let v = match self.buf.get(self.pos) { + Some(&v) => v, + None => return None, + }; + self.pos += 1; + let n = match v { + b'0'..=b'9' => v - 48, + b'A'..=b'F' => v - 55, + b'a'..=b'f' => v - 87, + b' ' | b'\r' | b'\n' | b'\t' => continue, + _ => panic!("invalid character"), + }; + return Some(n); + } + } +} + +impl Iterator for TokenTreeIter { + type Item = TokenTree; + + fn next(&mut self) -> Option { + let v = if self.is_punct { + TokenTree::Punct(Punct::new(',', Spacing::Alone)) + } else { + let p1 = self.next_hex_val()?; + let p2 = match self.next_hex_val() { + Some(v) => v, + None => panic!("expected even number of hex characters"), + }; + let val = (p1 << 4) + p2; + TokenTree::Literal(Literal::u8_suffixed(val)) + }; + self.is_punct = !self.is_punct; + Some(v) + } +} + +#[proc_macro] +pub fn hex(input: TokenStream) -> TokenStream { + let ts = TokenStream::from_iter(TokenTreeIter::new(input)); + TokenStream::from(TokenTree::Group(Group::new(Delimiter::Bracket, ts))) +}