move Windows code into a module (#924)

Author: Be-ing

dev-tools/gen-windows-sys-binding/src/main.rs

@@ -35,8 +35,10 @@ const fn invalid_mut<T>(addr: usize) -> *mut T {
 "#;
 
 fn main() -> io::Result<()> {
+    let manifest_dir = env!("CARGO_MANIFEST_DIR");
     // Load the list of APIs
-    let buffer = fs::read_to_string("windows_sys.list")?;
+    let buffer = fs::read_to_string(format!("{manifest_dir}/windows_sys.list"))
+        .expect("failed to read windows_sys.list");
     let names: Vec<&str> = buffer
         .lines()
         .filter_map(|line| {
@@ -53,7 +55,8 @@ fn main() -> io::Result<()> {
     let bindings =
         windows_bindgen::standalone_std(&names).replace("::core::ptr::invalid_mut", "invalid_mut");
 
-    let mut f = fs::File::create("../src/windows_sys.rs")?;
+    let mut f = fs::File::create(format!("{manifest_dir}/../../src/windows/windows_sys.rs"))
+        .expect("failed to create windows_sys.rs");
     f.write_all(PRELUDE.as_bytes())?;
     f.write_all(bindings.as_bytes())?;
     f.write_all(POSTLUDE.as_bytes())?;

src/lib.rs

@@ -69,23 +69,10 @@ use std::sync::{Arc, Mutex};
 mod os_pipe;
 #[cfg(feature = "parallel")]
 mod parallel;
-// These modules are all glue to support reading the MSVC version from
-// the registry and from COM interfaces
-#[cfg(windows)]
-mod registry;
-#[cfg(windows)]
-#[macro_use]
-mod winapi;
-#[cfg(windows)]
-mod com;
-#[cfg(windows)]
-mod setup_config;
-#[cfg(windows)]
-mod vs_instances;
-#[cfg(windows)]
-mod windows_sys;
-
-pub mod windows_registry;
+mod windows;
+// Regardless of whether this should be in this crate's public API,
+// it has been since 2015, so don't break it.
+pub use windows::find_tools as windows_registry;
 
 mod command_helpers;
 use command_helpers::*;

src/os_pipe/windows.rs

@@ -1,4 +1,4 @@
-use crate::windows_sys::{CreatePipe, INVALID_HANDLE_VALUE};
+use crate::windows::windows_sys::{CreatePipe, INVALID_HANDLE_VALUE};
 use std::{fs::File, io, os::windows::prelude::*, ptr};
 
 /// NOTE: These pipes do not support IOCP.

src/parallel/job_token/windows.rs

@@ -3,7 +3,7 @@ use std::{
     io, ptr,
 };
 
-use crate::windows_sys::{
+use crate::windows::windows_sys::{
     OpenSemaphoreA, ReleaseSemaphore, WaitForSingleObject, FALSE, HANDLE, SEMAPHORE_MODIFY_STATE,
     THREAD_SYNCHRONIZE, WAIT_ABANDONED, WAIT_FAILED, WAIT_OBJECT_0, WAIT_TIMEOUT,
 };

src/com.rs renamed to src/windows/com.rs

@@ -7,7 +7,7 @@
 
 #![allow(unused)]
 
-use crate::{
+use crate::windows::{
     winapi::{IUnknown, Interface},
     windows_sys::{
         CoInitializeEx, SysFreeString, SysStringLen, BSTR, COINIT_MULTITHREADED, HRESULT, S_FALSE,

src/windows_registry.rs renamed to src/windows/find_tools.rs

@@ -159,10 +159,10 @@ pub fn find_vs_version() -> Result<VsVers, String> {
 
 #[cfg(windows)]
 mod impl_ {
-    use crate::com;
-    use crate::registry::{RegistryKey, LOCAL_MACHINE};
-    use crate::setup_config::SetupConfiguration;
-    use crate::vs_instances::{VsInstances, VswhereInstance};
+    use crate::windows::com;
+    use crate::windows::registry::{RegistryKey, LOCAL_MACHINE};
+    use crate::windows::setup_config::SetupConfiguration;
+    use crate::windows::vs_instances::{VsInstances, VswhereInstance};
     use std::convert::TryFrom;
     use std::env;
     use std::ffi::OsString;

src/windows/mod.rs

@@ -0,0 +1,20 @@
+//! These modules are all glue to support reading the MSVC version from
+//! the registry and from COM interfaces.
+
+// This is used in the crate's public API, so don't use #[cfg(windows)]
+pub mod find_tools;
+
+#[cfg(windows)]
+pub(crate) mod windows_sys;
+
+#[cfg(windows)]
+mod registry;
+#[cfg(windows)]
+#[macro_use]
+mod winapi;
+#[cfg(windows)]
+mod com;
+#[cfg(windows)]
+mod setup_config;
+#[cfg(windows)]
+mod vs_instances;

src/registry.rs renamed to src/windows/registry.rs

@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-use crate::windows_sys::{
+use crate::windows::windows_sys::{
     RegCloseKey, RegEnumKeyExW, RegOpenKeyExW, RegQueryValueExW, ERROR_NO_MORE_ITEMS,
     ERROR_SUCCESS, HKEY, HKEY_LOCAL_MACHINE, KEY_READ, KEY_WOW64_32KEY, REG_SZ,
 };

src/setup_config.rs renamed to src/windows/setup_config.rs

@@ -8,7 +8,7 @@
 #![allow(bad_style)]
 #![allow(unused)]
 
-use crate::{
+use crate::windows::{
     com::{BStr, ComPtr},
     winapi::{
         IUnknown, IUnknownVtbl, Interface, LCID, LPCOLESTR, LPCWSTR, LPFILETIME, LPSAFEARRAY,

src/vs_instances.rs renamed to src/windows/vs_instances.rs

@@ -4,7 +4,7 @@ use std::convert::TryFrom;
 use std::io::BufRead;
 use std::path::PathBuf;
 
-use crate::setup_config::{EnumSetupInstances, SetupInstance};
+use crate::windows::setup_config::{EnumSetupInstances, SetupInstance};
 
 pub enum VsInstance {
     Com(SetupInstance),