diff --git a/.gitattributes b/.gitattributes index a9567e6535..e98263ebcb 100644 --- a/.gitattributes +++ b/.gitattributes @@ -5,3 +5,4 @@ *.winmd -text *.lib -text *.a -text +*.exe -text diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml index 38dda4ca3a..b437916967 100644 --- a/.github/workflows/clippy.yml +++ b/.github/workflows/clippy.yml @@ -32,6 +32,8 @@ jobs: run: rustup component add clippy - name: Fix environment uses: ./.github/actions/fix-environment + - name: Clippy cppwinrt + run: cargo clippy -p cppwinrt - name: Clippy no_std run: cargo clippy -p no_std - name: Clippy riddle @@ -50,6 +52,8 @@ jobs: run: cargo clippy -p sample_component_json_validator_winrt - name: Clippy sample_component_json_validator_winrt_client run: cargo clippy -p sample_component_json_validator_winrt_client + - name: Clippy sample_component_json_validator_winrt_client_cpp + run: cargo clippy -p sample_component_json_validator_winrt_client_cpp - name: Clippy sample_consent run: cargo clippy -p sample_consent - name: Clippy sample_core_app diff --git a/.github/workflows/no-default-features.yml b/.github/workflows/no-default-features.yml index 23e7ce54cf..b4b4978575 100644 --- a/.github/workflows/no-default-features.yml +++ b/.github/workflows/no-default-features.yml @@ -30,6 +30,8 @@ jobs: run: rustup target add ${{ matrix.target }} - name: Fix environment uses: ./.github/actions/fix-environment + - name: Check cppwinrt + run: cargo check -p cppwinrt --no-default-features - name: Check windows run: cargo check -p windows --no-default-features - name: Check windows-bindgen diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index db5d776699..c96865f987 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -56,6 +56,8 @@ jobs: uses: ./.github/actions/fix-environment - name: Clean run: cargo clean + - name: Test cppwinrt + run: cargo test -p cppwinrt --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test no_std run: cargo test -p no_std --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test riddle @@ -74,6 +76,8 @@ jobs: run: cargo test -p sample_component_json_validator_winrt --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test sample_component_json_validator_winrt_client run: cargo test -p sample_component_json_validator_winrt_client --target ${{ matrix.target }} ${{ matrix.etc }} + - name: Test sample_component_json_validator_winrt_client_cpp + run: cargo test -p sample_component_json_validator_winrt_client_cpp --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test sample_consent run: cargo test -p sample_consent --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test sample_core_app @@ -152,12 +156,12 @@ jobs: run: cargo test -p test_alternate_success_code --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test test_arch run: cargo test -p test_arch --target ${{ matrix.target }} ${{ matrix.etc }} + - name: Clean + run: cargo clean - name: Test test_arch_feature run: cargo test -p test_arch_feature --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test test_array run: cargo test -p test_array --target ${{ matrix.target }} ${{ matrix.etc }} - - name: Clean - run: cargo clean - name: Test test_bcrypt run: cargo test -p test_bcrypt --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test test_bstr @@ -254,12 +258,12 @@ jobs: run: cargo test -p test_standalone --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test test_string_param run: cargo test -p test_string_param --target ${{ matrix.target }} ${{ matrix.etc }} + - name: Clean + run: cargo clean - name: Test test_structs run: cargo test -p test_structs --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test test_sys run: cargo test -p test_sys --target ${{ matrix.target }} ${{ matrix.etc }} - - name: Clean - run: cargo clean - name: Test test_targets run: cargo test -p test_targets --target ${{ matrix.target }} ${{ matrix.etc }} - name: Test test_unions diff --git a/.gitignore b/.gitignore index 4c6fca839a..ca33c1fc2c 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ /target *.lock *.winmd +winrt diff --git a/crates/libs/cppwinrt/Cargo.toml b/crates/libs/cppwinrt/Cargo.toml new file mode 100644 index 0000000000..3d705640b9 --- /dev/null +++ b/crates/libs/cppwinrt/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "cppwinrt" +version = "0.1.0" +authors = ["Microsoft"] +edition = "2021" +rust-version = "1.60" +license = "MIT OR Apache-2.0" +description = "C++/WinRT" +repository = "https://github.com/microsoft/windows-rs" +readme = "readme.md" +categories = ["os::windows-apis"] + +[lints] +workspace = true + +[package.metadata.docs.rs] +default-target = "x86_64-pc-windows-msvc" +targets = [] diff --git a/crates/libs/cppwinrt/cppwinrt.exe b/crates/libs/cppwinrt/cppwinrt.exe new file mode 100644 index 0000000000..a53d530a14 Binary files /dev/null and b/crates/libs/cppwinrt/cppwinrt.exe differ diff --git a/crates/libs/cppwinrt/license-apache-2.0 b/crates/libs/cppwinrt/license-apache-2.0 new file mode 100644 index 0000000000..b5ed4ecec2 --- /dev/null +++ b/crates/libs/cppwinrt/license-apache-2.0 @@ -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 (c) Microsoft Corporation. + + 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/crates/libs/cppwinrt/license-mit b/crates/libs/cppwinrt/license-mit new file mode 100644 index 0000000000..9e841e7a26 --- /dev/null +++ b/crates/libs/cppwinrt/license-mit @@ -0,0 +1,21 @@ + MIT License + + Copyright (c) Microsoft Corporation. + + 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/crates/libs/cppwinrt/readme.md b/crates/libs/cppwinrt/readme.md new file mode 100644 index 0000000000..d0886d9241 --- /dev/null +++ b/crates/libs/cppwinrt/readme.md @@ -0,0 +1,31 @@ +## C++/WinRT + +The [cppwinrt](https://crates.io/crates/cppwinrt) crate bundles the C++/WinRT compiler for use in Rust. + +* [Getting started](https://kennykerr.ca/rust-getting-started/) +* [Samples](https://github.com/microsoft/windows-rs/tree/0.56.0/crates/samples) +* [Releases](https://github.com/microsoft/windows-rs/releases) + +Start by adding the following to your Cargo.toml file: + +```toml +[dependencies.cppwinrt] +version = "0.1" +``` + +Use `cppwinrt` function as needed: + +```rust +fn main() { + match cppwinrt::cppwinrt(["-help"]) { + Ok(output) => println!("{output}"), + Err(error) => println!("{error}"), + }; +} +``` + +Source: + +* +* +* Version 2.0.240405.15 diff --git a/crates/libs/cppwinrt/src/lib.rs b/crates/libs/cppwinrt/src/lib.rs new file mode 100644 index 0000000000..1819774a38 --- /dev/null +++ b/crates/libs/cppwinrt/src/lib.rs @@ -0,0 +1,43 @@ +/*! +Learn more about Rust for Windows here: +*/ + +const VERSION: &str = "2.0.240405.15"; + +/// Calls the C++/WinRT compiler with the given arguments. +/// +/// Use `cppwinrt["-help"]` for available options. +pub fn cppwinrt(args: I) -> Result +where + I: IntoIterator, + S: AsRef, +{ + let mut path = std::env::temp_dir(); + path.push(format!("cppwinrt-{VERSION}.exe")); + + std::fs::write(&path, std::include_bytes!("../cppwinrt.exe")).unwrap(); + let mut command = std::process::Command::new(&path); + command.args(args); + let output = command.output().expect("failed to run cppwinrt"); + _ = std::fs::remove_file(path); + + if output.status.success() { + Ok(String::from_utf8_lossy(&output.stdout).to_string()) + } else { + Err(String::from_utf8_lossy(&output.stderr).to_string()) + } +} + +#[cfg(test)] +mod tests { + use crate::*; + + #[test] + fn test() { + let ok = cppwinrt(["-help"]).unwrap(); + assert!(ok.contains(VERSION), "unexpected version"); + + let err = cppwinrt(["-invalid"]).unwrap_err(); + assert!(err.contains("'-invalid' is not supported")); + } +} diff --git a/crates/samples/components/json_validator_winrt_client_cpp/Cargo.toml b/crates/samples/components/json_validator_winrt_client_cpp/Cargo.toml new file mode 100644 index 0000000000..6e5dbd2125 --- /dev/null +++ b/crates/samples/components/json_validator_winrt_client_cpp/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "sample_component_json_validator_winrt_client_cpp" +version = "0.0.0" +edition = "2021" +publish = false + +[build-dependencies] +cc = "1.0" + +[build-dependencies.cppwinrt] +path = "../../../../crates/libs/cppwinrt" + +[dependencies.windows-targets] +path = "../../../../crates/libs/targets" + +# TODO: this causes a warning about lack of linkage target. The point is to ensure that this binary dependency is built first but +# Cargo doesn't respect cdylib targets. https://github.com/rust-lang/cargo/issues/7825 +[dependencies.sample_component_json_validator_winrt] +path = "../json_validator_winrt" diff --git a/crates/samples/components/json_validator_winrt_client_cpp/build.rs b/crates/samples/components/json_validator_winrt_client_cpp/build.rs new file mode 100644 index 0000000000..6293927b07 --- /dev/null +++ b/crates/samples/components/json_validator_winrt_client_cpp/build.rs @@ -0,0 +1,24 @@ +fn main() { + if !cfg!(target_env = "msvc") { + return; + } + + println!("cargo:rerun-if-changed=src/client.cpp"); + println!("cargo:rustc-link-lib=windows.0.52.0"); + + cppwinrt::cppwinrt([ + "-in", + "../json_validator_winrt/sample.winmd", + &format!("{}\\System32\\WinMetadata", env!("windir")), + "-out", + "src", + ]) + .unwrap(); + + cc::Build::new() + .cpp(true) + .std("c++20") + .flag("/EHsc") + .file("src/client.cpp") + .compile("client"); +} diff --git a/crates/samples/components/json_validator_winrt_client_cpp/src/client.cpp b/crates/samples/components/json_validator_winrt_client_cpp/src/client.cpp new file mode 100644 index 0000000000..f59de0d652 --- /dev/null +++ b/crates/samples/components/json_validator_winrt_client_cpp/src/client.cpp @@ -0,0 +1,34 @@ +#include "winrt/Sample.h" + +using namespace winrt::Sample; + +extern "C" { + void __stdcall client() noexcept { + auto schema = LR"( +{ + "properties": { + "name": { + "type": "string" + }, + "age": { + "type": "integer" + } + } +} + )"; + + auto value = LR"( +{ + "name": "Kenny", + "age": 21 +} + )"; + + // Create a validator with the given schema. + auto validator = JsonValidator(schema); + + // Validate and check the sanitized return value. + auto sanitized = validator.Validate(value); + assert(sanitized == LR"({"age":21,"name":"Kenny"})"); + } +} diff --git a/crates/samples/components/json_validator_winrt_client_cpp/src/lib.rs b/crates/samples/components/json_validator_winrt_client_cpp/src/lib.rs new file mode 100644 index 0000000000..6f1497b02a --- /dev/null +++ b/crates/samples/components/json_validator_winrt_client_cpp/src/lib.rs @@ -0,0 +1,11 @@ +#![cfg(target_env = "msvc")] + +#[test] +fn test() { + extern "system" { + fn client(); + } + unsafe { + client(); + } +} diff --git a/crates/tests/readme/Cargo.toml b/crates/tests/readme/Cargo.toml index 1ead2a6a89..2e6dc52009 100644 --- a/crates/tests/readme/Cargo.toml +++ b/crates/tests/readme/Cargo.toml @@ -37,3 +37,6 @@ path = "../../libs/registry" [dev-dependencies.windows-version] path = "../../libs/version" + +[dev-dependencies.cppwinrt] +path = "../../libs/cppwinrt" diff --git a/crates/tests/readme/src/lib.rs b/crates/tests/readme/src/lib.rs index e1d6bf36a6..6a1bd9cb79 100644 --- a/crates/tests/readme/src/lib.rs +++ b/crates/tests/readme/src/lib.rs @@ -6,3 +6,4 @@ #![doc = include_str!("../../../../crates/libs/targets/readme.md")] #![doc = include_str!("../../../../crates/libs/version/readme.md")] #![doc = include_str!("../../../../crates/libs/windows/readme.md")] +#![doc = include_str!("../../../../crates/libs/cppwinrt/readme.md")]