From 0ec5c1a347c5bb2b07a49499e8bc44e21996c3c7 Mon Sep 17 00:00:00 2001 From: Matt Joiner Date: Wed, 26 Jun 2024 17:42:22 +1000 Subject: [PATCH] Fix Windows cross-compilation and add ?Sized to use of Format trait By using windows-sys we can entirely remove the need for bindgen, and Windows.h enabling cross compilation to Windows. Additionally we relax the use of the Format trait to be ?Sized where possible, allowing to use fallback Format implementations through Box/dyn. --- Cargo.toml | 1 - num-format-windows/Cargo.toml | 21 --- num-format-windows/LICENSE-APACHE | 201 ------------------------ num-format-windows/LICENSE-MIT | 21 --- num-format-windows/README.md | 12 -- num-format-windows/README.tpl | 3 - num-format-windows/build.rs | 36 ----- num-format-windows/src/lib.rs | 17 -- num-format-windows/wrapper.h | 1 - num-format/Cargo.toml | 6 +- num-format/src/impls/integers.rs | 12 +- num-format/src/system_locale/windows.rs | 22 ++- num-format/src/to_formatted_str.rs | 2 +- num-format/src/to_formatted_string.rs | 6 +- 14 files changed, 22 insertions(+), 339 deletions(-) delete mode 100644 num-format-windows/Cargo.toml delete mode 100644 num-format-windows/LICENSE-APACHE delete mode 100644 num-format-windows/LICENSE-MIT delete mode 100644 num-format-windows/README.md delete mode 100644 num-format-windows/README.tpl delete mode 100644 num-format-windows/build.rs delete mode 100644 num-format-windows/src/lib.rs delete mode 100644 num-format-windows/wrapper.h diff --git a/Cargo.toml b/Cargo.toml index d24a47f..5c1f271 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,5 +3,4 @@ members = [ "num-format", "num-format-benches", "num-format-dev", - "num-format-windows", ] diff --git a/num-format-windows/Cargo.toml b/num-format-windows/Cargo.toml deleted file mode 100644 index 6214ed4..0000000 --- a/num-format-windows/Cargo.toml +++ /dev/null @@ -1,21 +0,0 @@ -[package] -name = "num-format-windows" -version = "0.4.4" # Remember to keep html_root_url in lib.rs in sync! - -authors = ["Brian Myers "] -categories = [] -description = "A helper crate for num-format. Do not use directly." -documentation = "https://docs.rs/num-format-windows" -edition = "2021" -homepage = "https://github.com/bcmyers/num-format/num-format-windows" -keywords = [] -license = "MIT/Apache-2.0" -publish = true -readme = "README.md" -repository = "https://github.com/bcmyers/num-format/num-format-windows" - -build = "build.rs" -include = ["build.rs", "Cargo.toml", "src/**/*", "wrapper.h"] - -[build-dependencies] -bindgen = "0.63.0" diff --git a/num-format-windows/LICENSE-APACHE b/num-format-windows/LICENSE-APACHE deleted file mode 100644 index 61268ba..0000000 --- a/num-format-windows/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 2018 Brian Myers - -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/num-format-windows/LICENSE-MIT b/num-format-windows/LICENSE-MIT deleted file mode 100644 index 9115259..0000000 --- a/num-format-windows/LICENSE-MIT +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 Brian Myers - -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/num-format-windows/README.md b/num-format-windows/README.md deleted file mode 100644 index 93f00a2..0000000 --- a/num-format-windows/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# num-format-windows - -A helper crate for [num-format] that only exists because num-format on Windows requires -[bindgen] as a build dependency, which, if not broken out into a separate crate, would -prevent num-format from being built in a `no_std` environment (build dependendies cannot -currently be made contingent on the compilation target). - -Said differently, don't use this crate directly. It's just a work-around for -[https://github.com/rust-lang/rust-bindgen/issues/1439](https://github.com/rust-lang/rust-bindgen/issues/1439). - -[bindgen]: https://github.com/rust-lang/rust-bindgen -[num-format]: https://github.com/bcmyers/num-format diff --git a/num-format-windows/README.tpl b/num-format-windows/README.tpl deleted file mode 100644 index 0d9b104..0000000 --- a/num-format-windows/README.tpl +++ /dev/null @@ -1,3 +0,0 @@ -# {{crate}} - -{{readme}} diff --git a/num-format-windows/build.rs b/num-format-windows/build.rs deleted file mode 100644 index 3308b81..0000000 --- a/num-format-windows/build.rs +++ /dev/null @@ -1,36 +0,0 @@ -#[cfg(windows)] -fn main() { - use std::env; - use std::path::Path; - - use bindgen::{Builder, RustTarget}; - - let root = env::var("CARGO_MANIFEST_DIR").unwrap(); - let headers_path = Path::new(&root).join("wrapper.h"); - let headers = headers_path.to_str().unwrap(); - - let bindings = Builder::default() - .header(headers) - .rust_target(RustTarget::Stable_1_33) - .allowlist_var("LOCALE_NAME_MAX_LENGTH") - .allowlist_var("LOCALE_NAME_SYSTEM_DEFAULT") - .allowlist_var("LOCALE_SDECIMAL") - .allowlist_var("LOCALE_SGROUPING") - .allowlist_var("LOCALE_SNAME") - .allowlist_var("LOCALE_SNAN") - .allowlist_var("LOCALE_SNEGATIVESIGN") - .allowlist_var("LOCALE_SNEGINFINITY") - .allowlist_var("LOCALE_SPOSINFINITY") - .allowlist_var("LOCALE_SPOSITIVESIGN") - .allowlist_var("LOCALE_STHOUSAND") - .generate() - .expect("unable to generate bindings for windows.h"); - - let out_path = Path::new(&env::var("OUT_DIR").unwrap()).join("bindings.rs"); - bindings - .write_to_file(&out_path) - .expect("unable to write bindings for windows.h"); -} - -#[cfg(not(windows))] -fn main() {} diff --git a/num-format-windows/src/lib.rs b/num-format-windows/src/lib.rs deleted file mode 100644 index b9af09e..0000000 --- a/num-format-windows/src/lib.rs +++ /dev/null @@ -1,17 +0,0 @@ -//! A helper crate for [num-format] that only exists because num-format on Windows requires -//! [bindgen] as a build dependency, which, if not broken out into a separate crate, would -//! prevent num-format from being built in a `no_std` environment (build dependendies cannot -//! currently be made contingent on the compilation target). -//! -//! Said differently, don't use this crate directly. It's just a work-around for -//! [https://github.com/rust-lang/rust-bindgen/issues/1439](https://github.com/rust-lang/rust-bindgen/issues/1439). -//! -//! [bindgen]: https://github.com/rust-lang/rust-bindgen -//! [num-format]: https://github.com/bcmyers/num-format -#![allow(non_camel_case_types)] -#![allow(non_snake_case)] -#![allow(non_upper_case_globals)] -#![doc(html_root_url = "https://docs.rs/num-format-windows/0.4.4")] - -#[cfg(windows)] -include!(concat!(env!("OUT_DIR"), "\\bindings.rs")); diff --git a/num-format-windows/wrapper.h b/num-format-windows/wrapper.h deleted file mode 100644 index 776a87c..0000000 --- a/num-format-windows/wrapper.h +++ /dev/null @@ -1 +0,0 @@ -#include diff --git a/num-format/Cargo.toml b/num-format/Cargo.toml index cdc2eef..da9be6f 100644 --- a/num-format/Cargo.toml +++ b/num-format/Cargo.toml @@ -27,15 +27,15 @@ encoding_rs = { version = "0.8.31", optional = true } libc = { version = "0.2.134", optional = true } [target.'cfg(windows)'.dependencies] -num-format-windows = { version = "0.4.4", optional = true } widestring = { version = "1.0.2", optional = true } -winapi = { version = "0.3.9", features = ["winnls"], optional = true } +winapi = { version = "0.3.9", features = ["winnls", "errhandlingapi"], optional = true } +windows-sys = { version = "0.52.0", features = ["Win32_Globalization", "Win32_System_SystemServices"] } [features] default = ["std"] std = ["arrayvec/default"] with-serde = ["arrayvec/serde", "serde/derive"] -with-system-locale = ["cfg-if", "encoding_rs", "lazy_static", "libc", "num-format-windows", "std", "widestring", "winapi/winnls"] +with-system-locale = ["cfg-if", "encoding_rs", "lazy_static", "libc", "std", "widestring", "winapi/winnls"] with-num-bigint = ["num-bigint", "std"] [dev-dependencies] diff --git a/num-format/src/impls/integers.rs b/num-format/src/impls/integers.rs index 64c273e..d7dad4a 100644 --- a/num-format/src/impls/integers.rs +++ b/num-format/src/impls/integers.rs @@ -18,7 +18,7 @@ impl ToFormattedStr for u8 { #[inline(always)] fn read_to_buffer<'a, F>(&self, buf: &'a mut Buffer, _: &F) -> usize where - F: Format, + F: Format + ?Sized, { buf.write_with_itoa(*self) } @@ -31,7 +31,7 @@ macro_rules! impl_unsigned { #[inline(always)] fn read_to_buffer<'a, F>(&self, buf: &'a mut Buffer, format: &F) -> usize where - F: Format, + F: Format + ?Sized, { let n = *self as u128; run_core_algorithm(n, buf, format) @@ -62,7 +62,7 @@ macro_rules! impl_signed { #[inline(always)] fn read_to_buffer<'a, F>(&self, buf: &'a mut Buffer, format: &F) -> usize where - F: Format, + F: Format + ?Sized, { if self.is_negative() { let n = (!(*self as u128)).wrapping_add(1); // make positive by adding 1 to the 2s complement @@ -105,7 +105,7 @@ impl ToFormattedStr for NonZeroU8 { #[inline(always)] fn read_to_buffer<'a, F>(&self, buf: &'a mut Buffer, _: &F) -> usize where - F: Format, + F: Format + ?Sized, { buf.write_with_itoa(self.get()) } @@ -118,7 +118,7 @@ macro_rules! impl_non_zero { #[inline(always)] fn read_to_buffer<'a, F>(&self, buf: &'a mut Buffer, format: &F) -> usize where - F: Format, + F: Format + ?Sized, { let n = self.get() as u128; run_core_algorithm(n, buf, format) @@ -145,7 +145,7 @@ impl Sealed for NonZeroU128 {} #[inline(always)] fn run_core_algorithm(mut n: u128, buf: &mut Buffer, format: &F) -> usize where - F: Format, + F: Format + ?Sized, { // Bail out early if we can just use itoa // (i.e. if we don't have a separator) diff --git a/num-format/src/system_locale/windows.rs b/num-format/src/system_locale/windows.rs index 5097246..acb8b55 100644 --- a/num-format/src/system_locale/windows.rs +++ b/num-format/src/system_locale/windows.rs @@ -2,15 +2,16 @@ use std::borrow::Cow; use std::collections::HashSet; -use std::ffi::CStr; use std::ptr; use std::sync::{Arc, Mutex}; -use num_format_windows::{ - LOCALE_NAME_MAX_LENGTH, LOCALE_NAME_SYSTEM_DEFAULT, LOCALE_SDECIMAL, LOCALE_SGROUPING, - LOCALE_SNAME, LOCALE_SNAN, LOCALE_SNEGATIVESIGN, LOCALE_SNEGINFINITY, LOCALE_SPOSINFINITY, - LOCALE_SPOSITIVESIGN, LOCALE_STHOUSAND, +use windows_sys::Win32::Globalization::{ + LOCALE_NAME_SYSTEM_DEFAULT, LOCALE_SDECIMAL, LOCALE_SGROUPING, LOCALE_SNAME, LOCALE_SNAN, + LOCALE_SNEGATIVESIGN, LOCALE_SNEGINFINITY, LOCALE_SPOSINFINITY, LOCALE_SPOSITIVESIGN, + LOCALE_STHOUSAND, }; +use windows_sys::Win32::System::SystemServices::LOCALE_NAME_MAX_LENGTH; + use widestring::{U16CStr, U16CString}; use winapi::ctypes::c_int; use winapi::shared::minwindef::{BOOL, DWORD, LPARAM}; @@ -24,18 +25,13 @@ use crate::strings::{DecString, InfString, MinString, NanString, PlusString, Sep use crate::system_locale::SystemLocale; lazy_static! { - static ref SYSTEM_DEFAULT: Result<&'static str, Error> = { - CStr::from_bytes_with_nul(LOCALE_NAME_SYSTEM_DEFAULT).map_err(|_| { + static ref SYSTEM_DEFAULT: Result = { + Ok(unsafe{U16CStr::from_ptr_str(LOCALE_NAME_SYSTEM_DEFAULT)}.to_string().map_err(|_| { Error::system_invalid_return( "LOCALE_NAME_SYSTEM_DEFAULT", "LOCALE_NAME_SYSTEM_DEFAULT from windows.h unexpectedly contains interior nul byte.", ) - })?.to_str().map_err(|_| { - Error::system_invalid_return( - "LOCALE_NAME_SYSTEM_DEFAULT", - "LOCALE_NAME_SYSTEM_DEFAULT from windows.h unexpectedly contains invalid UTF-8.", - ) - }) + })?) }; } diff --git a/num-format/src/to_formatted_str.rs b/num-format/src/to_formatted_str.rs index ed98871..e26dc62 100644 --- a/num-format/src/to_formatted_str.rs +++ b/num-format/src/to_formatted_str.rs @@ -11,5 +11,5 @@ pub trait ToFormattedStr: Sealed + Sized { #[doc(hidden)] fn read_to_buffer(&self, buf: &mut Buffer, format: &F) -> usize where - F: Format; + F: Format + ?Sized; } diff --git a/num-format/src/to_formatted_string.rs b/num-format/src/to_formatted_string.rs index 2db4c0b..56e8c8f 100644 --- a/num-format/src/to_formatted_string.rs +++ b/num-format/src/to_formatted_string.rs @@ -16,7 +16,7 @@ pub trait ToFormattedString: Sealed + Sized { #[doc(hidden)] fn read_to_fmt_writer(&self, w: W, format: &F) -> Result where - F: Format, + F: Format + ?Sized, W: fmt::Write; #[doc(hidden)] @@ -28,7 +28,7 @@ pub trait ToFormattedString: Sealed + Sized { /// Returns a string representation of the number formatted according to the provided format. fn to_formatted_string(&self, format: &F) -> String where - F: Format, + F: Format + ?Sized, { let mut s = String::with_capacity(MAX_BUF_LEN); let _ = self.read_to_fmt_writer(&mut s, format).unwrap(); @@ -43,7 +43,7 @@ where #[inline(always)] fn read_to_fmt_writer(&self, mut w: W, format: &F) -> Result where - F: Format, + F: Format + ?Sized, W: fmt::Write, { let mut buf = Buffer::default();