diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..a45739d --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,67 @@ +name: ci + +on: + pull_request: + push: + schedule: + - cron: '00 00 * * *' + +env: + # Coloured output from Cargo. + CARGO_TERM_COLOR: always + +jobs: + test: + name: test + runs-on: ubuntu-latest + env: + # Emit backtraces on panics. + RUST_BACKTRACE: 1 + strategy: + fail-fast: false + matrix: + build: + - pinned + - stable + - beta + - nightly + include: + - build: pinned + rust: 1.45.0 + - build: stable + rust: stable + - build: beta + rust: beta + - build: nightly + rust: nightly + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + toolchain: ${{ matrix.rust }} + override: true + profile: minimal + + - name: Run tests + run: cargo test --verbose --workspace + + rustfmt: + name: rustfmt + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + toolchain: nightly + override: true + profile: minimal + components: rustfmt + + - name: Check formatting + run: cargo fmt --all -- --check diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 579f1f0..0000000 --- a/.travis.yml +++ /dev/null @@ -1,28 +0,0 @@ -sudo: false -language: rust -cache: cargo - -rust: - - stable - - nightly - -script: - - cargo build - -matrix: - include: - - rust: stable - env: ROLE=test - script: - - cargo test --all-features --release - allow_failures: - - rust: nightly - env: ROLE=test - script: - - cargo test --all-features --release - - rust: nightly - env: ROLE=clippy - script: - - cargo install clippy --debug --force || exit - - cargo clippy --all-features -- -Dclippy - fast_finish: true diff --git a/Cargo.toml b/Cargo.toml index cf8ceb5..5635790 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,29 +1,23 @@ [package] name = "wchar" -version = "0.6.1" +version = "0.7.0" authors = ["Juici "] description = "Procedural macros for compile time UTF-16 strings" edition = "2018" +license = "MIT OR Apache-2.0" +readme = "README.md" -documentation = "https://docs.rs/wchar" -homepage = "https://github.com/Juici/wchar-rs" repository = "https://github.com/Juici/wchar-rs" -readme = "README.md" -license = "MIT" +documentation = "https://docs.rs/wchar" keywords = ["wide", "string", "wchar", "utf16"] categories = ["text-processing"] -[badges] -travis-ci = { repository = "Juici/wchar-rs" } -maintenance = { status = "passively-maintained" } - [dependencies] -proc-macro-hack = "0.5" - -[dependencies.wchar-impl] -version = "0.6" -path = "./wchar-impl" +wchar-impl = { version = "=0.7.0", path = "impl" } [dev-dependencies] trybuild = "1.0" + +[workspace] +members = ["impl"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..261eeb9 --- /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 b/LICENSE-MIT similarity index 97% rename from LICENSE rename to LICENSE-MIT index d854995..4ebcc61 100644 --- a/LICENSE +++ b/LICENSE-MIT @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 Juici +Copyright (c) 2021 James Whaley Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 20d09a1..e2fa194 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ -# wchar-rs   [![Travis build status]][travis] [![Latest Version]][crates.io] [![API docs]][docs.rs] +# wchar -[Travis build status]: https://travis-ci.com/Juici/wchar-rs.svg?branch=master -[travis]: https://travis-ci.com/Juici/wchar-rs - -[Appveyor build status]: https://ci.appveyor.com/api/projects/status/github/Juici/wchar-rs?svg=true&branch=master -[appveyor]: https://ci.appveyor.com/project/Juici/wchar-rs - -[Latest Version]: https://img.shields.io/crates/v/wchar.svg -[crates.io]: https://crates.io/crates/wchar - -[API docs]: https://docs.rs/wchar/badge.svg -[docs.rs]: https://docs.rs/wchar +[build status](https://github.com/Juici/wchar-rs/actions?query=branch%3Amaster) +[crates.io](https://crates.io/crates/wchar) +[docs.rs](https://docs.rs/wchar) **Procedural macros for compile time UTF-16 wide strings.** This crate introduces two macros to create UTF-16 wide strings at compiler time, like the `L` literal in C. + +## License + +This project is licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) +or [MIT License](LICENSE-MIT) at your option. + +### 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. diff --git a/wchar-impl/Cargo.toml b/impl/Cargo.toml similarity index 53% rename from wchar-impl/Cargo.toml rename to impl/Cargo.toml index f0f681d..f2d7ee6 100644 --- a/wchar-impl/Cargo.toml +++ b/impl/Cargo.toml @@ -1,24 +1,17 @@ [package] name = "wchar-impl" -version = "0.6.0" +version = "0.7.0" authors = ["Juici "] description = "Internal implementation of wchar using proc-macro-hack" edition = "2018" +license = "MIT or Apache-2.0" -documentation = "https://docs.rs/wchar" -homepage = "https://github.com/Juici/wchar-rs" repository = "https://github.com/Juici/wchar-rs" -license = "MIT" [lib] proc-macro = true [dependencies] proc-macro2 = "1.0" -proc-macro-hack = "0.5" quote = "1.0" - -[dependencies.syn] -version = "1.0" -default-features = false -features = ["derive", "parsing", "proc-macro"] +syn = "1.0" diff --git a/wchar-impl/src/lib.rs b/impl/src/lib.rs similarity index 94% rename from wchar-impl/src/lib.rs rename to impl/src/lib.rs index 6e9d043..ae4d868 100644 --- a/wchar-impl/src/lib.rs +++ b/impl/src/lib.rs @@ -2,10 +2,9 @@ extern crate proc_macro; use std::iter::once; -use proc_macro_hack::proc_macro_hack; use syn::LitStr; -#[proc_macro_hack] +#[proc_macro] pub fn wch(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let lit: LitStr = syn::parse_macro_input!(input as LitStr); @@ -19,7 +18,7 @@ pub fn wch(input: proc_macro::TokenStream) -> proc_macro::TokenStream { expanded.into() } -#[proc_macro_hack] +#[proc_macro] pub fn wch_c(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let lit: LitStr = syn::parse_macro_input!(input as LitStr); diff --git a/rustfmt.toml b/rustfmt.toml index c3476d7..5f180c8 100644 --- a/rustfmt.toml +++ b/rustfmt.toml @@ -1,20 +1,8 @@ -max_width = 100 -hard_tabs = false -tab_spaces = 4 -wrap_comments = true -comment_width = 80 -normalize_comments = true -merge_imports = false -reorder_imports = true -reorder_modules = true -reorder_impl_items = true -trailing_semicolon = true -trailing_comma = "Vertical" -match_block_trailing_comma = false -blank_lines_upper_bound = 1 -blank_lines_lower_bound = 0 -merge_derives = true -use_try_shorthand = true unstable_features = true +version = "Two" edition = "2018" + +max_width = 100 +comment_width = 80 +# wrap_comments = true diff --git a/src/lib.rs b/src/lib.rs index b10842c..110f06a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -3,9 +3,6 @@ //! This crate introduces two macros [`wch!`] and [`wch_c!`] to create UTF-16 //! wide strings at compiler time, like the `L` literal in C. //! -//! In order to use the macro the `proc_macro` and `proc_macro_non_items` -//! features must be enabled. -//! //! [`wch!`]: macro.wch.html //! [`wch_c!`]: macro.wch_c.html //! @@ -25,8 +22,6 @@ #![no_std] -use proc_macro_hack::proc_macro_hack; - /// Generate a UTF-16 wide string from the given string literal. /// /// The generated output takes the form of a slice of wide characters @@ -59,7 +54,7 @@ use proc_macro_hack::proc_macro_hack; /// /// assert_eq!(wide_str, expected); /// ``` -#[proc_macro_hack] +#[deprecated(since = "0.7.0", note = "Prefer to use the wstr! macro")] pub use wchar_impl::wch; /// Generate a C-style nul-terminated UTF-16 wide string from the given string @@ -94,5 +89,5 @@ pub use wchar_impl::wch; /// /// assert_eq!(wide_str, expected); /// ``` -#[proc_macro_hack] +#[deprecated(since = "0.7.0", note = "Prefer to use the wstrz! macro")] pub use wchar_impl::wch_c;