Merge branch 'msvc-default-rust' into 'main'

NMake Makefiles: Default to using the default Rust toolchain

See merge request GNOME/librsvg!840

Author: Marge Bot

win32/MSVC-Builds.md

@@ -24,11 +24,18 @@ dependencies:
 
 You will also need the following tools:
 *  Visual Studio 2013 or later, with C/C++ compilation support (MSVC).
-*  The Rust Compiler and tools with the msvc toolchain(s) installed, that
-   matches the architecture that is being built.  It is recommended to use
-   the `rustup` tool from https://www.rust-lang.org/ to install and
-   configure Rust, which will install Rust in `%HOMEPATH%\.cargo` by
-   default.
+*  The Rust Compiler and tools with the msvc toolchain(s) and/or target(s)
+   installed, that matches the architecture that is being built.  It is
+   recommended to use the `rustup` tool from https://www.rust-lang.org/
+   to install and configure Rust, which will install Rust in
+   `%HOMEPATH%\.cargo` by default, which will be the default location that
+   is looked up for the `rustup` and `cargo` tools. If no `TOOLCHAIN_VERSION`
+   is specified (or if you are carrying out a cross-build), you need to
+   ensure that you added the target architecture to your default toolchain
+   via `rustup` if the architecture differs from the toolchain's architure.
+   If `TOOLCHAIN_VERSION` is specified and a cross-build is not carried out,
+   you will need to ensure the corresponding toolchain for the target
+   architecture is installed.
 *  `pkg-config` tool (or something that is compatible, set via
    `PKG_CONFIG` in the NMake command line if cross-compiling, or if in a
    non-standard location).  `PKG_CONFIG_PATH` in the NMake command line is
@@ -168,12 +175,10 @@ Where:
        that HarfBuzz, FontConfig and FreeType will also be required for
        the test programs to run.
     *  `VERBOSE`: Use verbose mode when building the Rust code.
-    *  `USE_NIGHTLY_TOOLCHAIN`, `TOOLCHAIN_VERSION=<Rust_toolchain_version>`:
-       Use a nightly (unstable) Rust toolchain or an installed previous-stable
-       version of the Rust toolchain instead of the latest stable toolchain,
-       which is the default. Useful for testing the librsvg code against an
-       unstable toolchain or the unstable toolchain itself, or if the
-       latest Rust toolchain release introduced unexpected issues.  Note
-       that `USE_NIGHTLY_TOOLCHAIN` takes precedence over
-       `TOOLCHAIN_VERSION`, and `TOOLCHAIN_VERSION=nightly` is the same
-       as `USE_NIGHTLY_TOOLCHAIN=1`
+    *  `TOOLCHAIN_VERSION=<Rust_toolchain_version>`:
+       Use an specified installed version (or nightly version)
+       of the Rust toolchain instead of the default toolchain.
+       Useful for testing the librsvg code against a nightly toolchain
+       or the unstable toolchain itself, or if the latest Rust toolchain
+       release (which is often set as the default) introduced unexpected
+       issues.

win32/Makefile.am

@@ -15,6 +15,7 @@ EXTRA_DIST = \
 	Makefile.vc		\
 	MSVC-Builds.md		\
 	rsvg-rust.mak		\
+	rust-default-target.bat	\
 	pc_base.py		\
 	replace.py		\
 	rsvgpc.py

win32/info-msvc.mak

@@ -110,12 +110,10 @@ help:
 	@echo VERBOSE:
 	@echo Run Cargo (i.e. the Rust compilation) in verbose mode.
 	@echo.
-	@echo USE_NIGHTLY_TOOLCHAIN/TOOLCHAIN_VERSION:
-	@echo Use a nightly Rust toolchain or a specific toolchain version instead of
-	@echo the latest installed stable one.  Notice the nightly toolchain or specified
-	@echo toolchain version for the target architecture must be installed beforehand.
-	@echo (note that TOOLCHAIN_VERSION=nightly is the same as USE_NIGHTLY_TOOLCHAIN=1,
-	@echo and USE_NIGHTLY_TOOLCHAIN takes precedence over TOOLCHAIN_VERSION).
+	@echo TOOLCHAIN_VERSION:
+	@echo Use a specific release or nightly toolchain version instead of
+	@echo the default one.  Notice the specified toolchain version
+    @for the target architecture must be installed beforehand.
 	@echo ======
 	@echo.
 	@echo Other options:

win32/rsvg-rust.mak

@@ -6,21 +6,41 @@ LIBDIR=$(PREFIX)\lib
 !endif
 
 !if "$(CARGO)" == ""
-CARGO = cargo
+CARGO = %HOMEPATH%\.cargo\bin\cargo
 !endif
 
 !if "$(RUSTUP)" == ""
-RUSTUP = rustup
+RUSTUP = %HOMEPATH%\.cargo\bin\rustup
 !endif
 
-# For those who wish to use the nightly toolchain or a particular
-# toolchain version to build librsvg
-!ifdef USE_NIGHTLY_TOOLCHAIN
-TOOLCHAIN_TYPE = nightly
-!elseif defined(TOOLCHAIN_VERSION)
+!if [call rust-default-target.bat $(RUSTUP)]
+!endif
+!include rust-cfg.mak
+!if [del /f/q rust-cfg.mak]
+!endif
+
+# For those who wish to use a particular toolchain version to build librsvg
+!if defined(TOOLCHAIN_VERSION)
 TOOLCHAIN_TYPE = $(TOOLCHAIN_VERSION)
 !else
-TOOLCHAIN_TYPE = stable
+TOOLCHAIN_TYPE =
+!endif
+
+!if "$(TOOLCHAIN_TYPE)" == ""
+!if "$(RUST_DEFAULT_COMPILER)" != "pc-windows-msvc"
+!error The default Rust toolchain is not an MSVC toolchain. Please use `rustup` to set the default to an MSVC toolchain
+!endif
+TOOLCHAIN_TYPE = $(RUST_DEFAULT_CHANNEL)
+BUILD_HOST = $(RUST_DEFAULT_TARGET)
+# non-default toolchain requested
+!else
+!if "$(PROCESSOR_ARCHITECTURE)" == "x64" || "$(PROCESSOR_ARCHITECTURE)" == "X64" || "$(PROCESSOR_ARCHITECTURE)" == "AMD64"
+BUILD_HOST = x64
+!elseif "$(PROCESSOR_ARCHITECTURE)" == "ARM64"
+BUILD_HOST = arm64
+!elseif "$(PROCESSOR_ARCHITECTURE)" == "x86"
+BUILD_HOST = Win32
+!endif
 !endif
 
 !ifdef VERBOSE
@@ -32,26 +52,37 @@ RUST_VERBOSE_FLAG = --verbose
 FORCE_CROSS = 0
 !endif
 
+# Setup cross builds if needed
 !if "$(PLAT)" == "x64"
 RUST_TARGET = x86_64
-!if "$(PROCESSOR_ARCHITECTURE)" == "ARM64"
+!if "$(BUILD_HOST)" != "$(PLAT)"
 FORCE_CROSS = 1
+!if "$(BUILD_HOST)" == "arm64"
 RUST_HOST = aarch64
-!elseif "$(PROCESSOR_ARCHITECTURE)" == "x86"
-FORCE_CROSS = 1
+!elseif "$(BUILD_HOST)" == "Win32"
 RUST_HOST = i686
 !endif
+!endif
 !elseif "$(PLAT)" == "arm64"
 RUST_TARGET = aarch64
-!if "$(PROCESSOR_ARCHITECTURE)" == "x64" || "$(PROCESSOR_ARCHITECTURE)" == "X64" || "$(PROCESSOR_ARCHITECTURE)" == "AMD64"
+!if "$(BUILD_HOST)" != "$(PLAT)"
 FORCE_CROSS = 1
+!if "$(BUILD_HOST)" == "x64"
 RUST_HOST = x86_64
-!elseif "$(PROCESSOR_ARCHITECTURE)" == "x86"
-FORCE_CROSS = 1
+!elseif "$(BUILD_HOST)" == "Win32"
 RUST_HOST = i686
 !endif
+!endif
 !else
 RUST_TARGET = i686
+!if "$(BUILD_HOST)" != "$(PLAT)"
+FORCE_CROSS = 1
+!if "$(BUILD_HOST)" == "arm64"
+RUST_HOST = aarch64
+!elseif "$(BUILD_HOST)" == "x64"
+RUST_HOST = x86_64
+!endif
+!endif
 !endif
 
 !if "$(VALID_CFGSET)" == "TRUE"
@@ -63,21 +94,23 @@ BUILD_RUST = 0
 !if "$(BUILD_RUST)" == "1"
 
 CARGO_TARGET = $(RUST_TARGET)-pc-windows-msvc
-CARGO_TARGET_CMD = --target $(CARGO_TARGET)
-CARGO_TARGET_TOOLCHAIN = $(TOOLCHAIN_TYPE)-$(CARGO_TARGET)
+CARGO_TARGET_TOOLCHAIN = +$(TOOLCHAIN_TYPE)-$(CARGO_TARGET)
+
 RUSTUP_CMD = $(RUSTUP) default $(DEFAULT_TARGET)
 CARGO_TARGET_DIR = vs$(VSVER)\$(CFG)\$(PLAT)\obj\rsvg_c_api
 CARGO_TARGET_DIR_FLAG = --target-dir=$(CARGO_TARGET_DIR)
 
 MANIFEST_PATH_FLAG = --manifest-path=..\Cargo.toml
 !if $(FORCE_CROSS) > 0
-RUST_HOST_TOOLCHAIN = $(TOOLCHAIN_TYPE)-$(RUST_HOST)-pc-windows-msvc
-CARGO_CMD = $(CARGO) +$(RUST_HOST_TOOLCHAIN) --locked build $(CARGO_TARGET_CMD) $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
-CARGO_CLEAN_CMD = $(CARGO) +$(RUST_HOST_TOOLCHAIN) clean $(CARGO_TARGET_CMD) $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
+RUST_HOST_TOOLCHAIN = +$(TOOLCHAIN_TYPE)-$(RUST_HOST)-pc-windows-msvc
+
+CARGO_TARGET_CMD = --target $(CARGO_TARGET)
+CARGO_CMD = $(CARGO) $(RUST_HOST_TOOLCHAIN) --locked build $(CARGO_TARGET_CMD) $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
+CARGO_CLEAN_CMD = $(CARGO) $(RUST_HOST_TOOLCHAIN) clean $(CARGO_TARGET_CMD) $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
 CARGO_TARGET_OUTPUT_DIR = $(CARGO_TARGET_DIR)\$(CARGO_TARGET)\$(CFG)
 !else
-CARGO_CMD = $(CARGO) +$(CARGO_TARGET_TOOLCHAIN) --locked build $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
-CARGO_CLEAN_CMD = $(CARGO) +$(CARGO_TARGET_TOOLCHAIN) clean $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
+CARGO_CMD = $(CARGO) $(CARGO_TARGET_TOOLCHAIN) --locked build $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
+CARGO_CLEAN_CMD = $(CARGO) $(CARGO_TARGET_TOOLCHAIN) clean $(MANIFEST_PATH_FLAG) $(CARGO_TARGET_DIR_FLAG)
 CARGO_TARGET_OUTPUT_DIR = $(CARGO_TARGET_DIR)\$(CFG)
 !endif
 !if "$(CFG)" == "release" || "$(CFG)" == "Release"
@@ -125,8 +158,8 @@ build-$(PLAT)-$(CFG).pre.bat:
 	@echo set __VSCMD_PREINIT_VCToolsVersion=>>$@
 	@echo set __VSCMD_PREINIT_VS160COMNTOOLS=>>$@
 	@echo set __VSCMD_script_err_count=>>$@
-	@echo if not "$(__VSCMD_PREINIT_PATH)" == "" set PATH=$(__VSCMD_PREINIT_PATH);%HOMEPATH%\.cargo\bin>>$@
-	@echo if "$(__VSCMD_PREINIT_PATH)" == "" set PATH=c:\Windows\system;c:\Windows;c:\Windows\system32\wbem;%HOMEPATH%\.cargo\bin>>$@
+	@echo if not "$(__VSCMD_PREINIT_PATH)" == "" set PATH=$(__VSCMD_PREINIT_PATH)>>$@
+	@echo if "$(__VSCMD_PREINIT_PATH)" == "" set PATH=c:\Windows\system;c:\Windows;c:\Windows\system32\wbem>>$@
 	@echo set GTK_LIB_DIR=$(LIBDIR)>>$@
 	@echo set SYSTEM_DEPS_FREETYPE2_NO_PKG_CONFIG=1 >>$@
 	@echo set SYSTEM_DEPS_FREETYPE2_LIB=$(FREETYPE_LIB:.lib=)>>$@
@@ -170,7 +203,6 @@ $(RSVG_INTERNAL_LIB):
 	@set GTK_LIB_DIR=
 
 $(CARGO_TARGET_OUTPUT_DIR)\rsvg-convert.exe:
-	@set PATH=%PATH%;%HOMEPATH%\.cargo\bin
 	@set GTK_LIB_DIR=$(LIBDIR);$(LIB)
 	@set SYSTEM_DEPS_FREETYPE2_NO_PKG_CONFIG=1
 	@set SYSTEM_DEPS_FREETYPE2_LIB=$(FREETYPE_LIB:.lib=)
@@ -183,7 +215,6 @@ $(CARGO_TARGET_OUTPUT_DIR)\rsvg-convert.exe:
 !endif
 
 cargo-clean:
-	@set PATH=%PATH%;%HOMEPATH%\.cargo\bin
 	@if exist build-$(PLAT)-$(CFG).bat del /f/q build-$(PLAT)-$(CFG).bat
 	@$(CARGO_CLEAN_CMD)
 

win32/rust-default-target.bat

@@ -0,0 +1,36 @@
+@echo off
+:: SETLOCAL ENABLEDELAYEDEXPANSION
+set RUSTUP=%1
+
+FOR /F "tokens=* USEBACKQ" %%F IN (`%RUSTUP% default`) DO (
+SET RUST_DEFAULT_TOOLCHAIN=%%F
+)
+
+:: We want to be very sure that if we are using the default
+:: Rust toolchain for the build, we are indeed using an msvc
+:: one!
+
+FOR /F "tokens=1,2,3,4,5*  delims=-" %%a IN ("%RUST_DEFAULT_TOOLCHAIN%") do (
+:: <version>-<platform>-pc-windows-msvc (default) or  stable-<platform>-pc-windows-msvc (default)
+if not "%%a" == "nightly" set CHANNEL=%%a
+if not "%%a" == "nightly" set TARGET=%%b
+if not "%%a" == "nightly" FOR /F "tokens=1,2 delims= " %%o IN ("%%e") do (
+set TOOLCHAIN_COMPILER=%%c-%%d-%%o
+)
+
+:: nightly-yyyy-mm-dd-<platform>-pc-windows-msvc (default)
+if "%%a" == "nightly" set CHANNEL=%%a-%%b-%%c
+if "%%a" == "nightly" set TARGET=%%e
+if "%%a" == "nightly" FOR /F "tokens=1,2 delims= " %%o IN ("%%f") do (
+set TOOLCHAIN_COMPILER=%%o
+)
+)
+
+if "%TARGET%" == "aarch64" set NMAKE_TGT=amd64
+if "%TARGET%" == "x86_64" set NMAKE_TGT=x64
+if "%TARGET%" == "i686" set NMAKE_TGT=Win32
+
+if exist rust-cfg.mak goto :EOF
+echo RUST_DEFAULT_CHANNEL=%CHANNEL%>>rust-cfg.mak
+echo RUST_DEFAULT_TARGET=%NMAKE_TGT%>>rust-cfg.mak
+echo RUST_DEFAULT_COMPILER=%TOOLCHAIN_COMPILER%>>rust-cfg.mak