mirror of
https://github.com/tauri-apps/tauri.git
synced 2025-01-03 16:42:42 +03:00
499 lines
16 KiB
Rust
499 lines
16 KiB
Rust
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//! [](https://tauri.app)
|
|
//!
|
|
//! This applies the macros at build-time in order to rig some special features needed by `cargo`.
|
|
|
|
#![doc(
|
|
html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png",
|
|
html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png"
|
|
)]
|
|
#![cfg_attr(doc_cfg, feature(doc_cfg))]
|
|
|
|
use anyhow::Context;
|
|
pub use anyhow::Result;
|
|
use cargo_toml::Manifest;
|
|
use heck::AsShoutySnakeCase;
|
|
|
|
use tauri_utils::{
|
|
config::Config,
|
|
resources::{external_binaries, resource_relpath, ResourcePaths},
|
|
};
|
|
|
|
use std::{
|
|
env::var_os,
|
|
path::{Path, PathBuf},
|
|
};
|
|
|
|
mod allowlist;
|
|
#[cfg(feature = "codegen")]
|
|
mod codegen;
|
|
/// Tauri configuration functions.
|
|
pub mod config;
|
|
/// Mobile build functions.
|
|
pub mod mobile;
|
|
mod static_vcruntime;
|
|
|
|
#[cfg(feature = "codegen")]
|
|
#[cfg_attr(doc_cfg, doc(cfg(feature = "codegen")))]
|
|
pub use codegen::context::CodegenContext;
|
|
|
|
fn copy_file(from: impl AsRef<Path>, to: impl AsRef<Path>) -> Result<()> {
|
|
let from = from.as_ref();
|
|
let to = to.as_ref();
|
|
if !from.exists() {
|
|
return Err(anyhow::anyhow!("{:?} does not exist", from));
|
|
}
|
|
if !from.is_file() {
|
|
return Err(anyhow::anyhow!("{:?} is not a file", from));
|
|
}
|
|
let dest_dir = to.parent().expect("No data in parent");
|
|
std::fs::create_dir_all(dest_dir)?;
|
|
std::fs::copy(from, to)?;
|
|
Ok(())
|
|
}
|
|
|
|
fn copy_binaries(
|
|
binaries: ResourcePaths,
|
|
target_triple: &str,
|
|
path: &Path,
|
|
package_name: Option<&String>,
|
|
) -> Result<()> {
|
|
for src in binaries {
|
|
let src = src?;
|
|
println!("cargo:rerun-if-changed={}", src.display());
|
|
let file_name = src
|
|
.file_name()
|
|
.expect("failed to extract external binary filename")
|
|
.to_string_lossy()
|
|
.replace(&format!("-{target_triple}"), "");
|
|
|
|
if package_name.map_or(false, |n| n == &file_name) {
|
|
return Err(anyhow::anyhow!(
|
|
"Cannot define a sidecar with the same name as the Cargo package name `{}`. Please change the sidecar name in the filesystem and the Tauri configuration.",
|
|
file_name
|
|
));
|
|
}
|
|
|
|
let dest = path.join(file_name);
|
|
if dest.exists() {
|
|
std::fs::remove_file(&dest).unwrap();
|
|
}
|
|
copy_file(&src, &dest)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// Copies resources to a path.
|
|
fn copy_resources(resources: ResourcePaths<'_>, path: &Path) -> Result<()> {
|
|
for src in resources {
|
|
let src = src?;
|
|
println!("cargo:rerun-if-changed={}", src.display());
|
|
let dest = path.join(resource_relpath(&src));
|
|
copy_file(&src, dest)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
// checks if the given Cargo feature is enabled.
|
|
fn has_feature(feature: &str) -> bool {
|
|
// when a feature is enabled, Cargo sets the `CARGO_FEATURE_<name` env var to 1
|
|
// https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts
|
|
std::env::var(format!("CARGO_FEATURE_{}", AsShoutySnakeCase(feature)))
|
|
.map(|x| x == "1")
|
|
.unwrap_or(false)
|
|
}
|
|
|
|
// creates a cfg alias if `has_feature` is true.
|
|
// `alias` must be a snake case string.
|
|
fn cfg_alias(alias: &str, has_feature: bool) {
|
|
if has_feature {
|
|
println!("cargo:rustc-cfg={alias}");
|
|
}
|
|
}
|
|
|
|
/// Attributes used on Windows.
|
|
#[allow(dead_code)]
|
|
#[derive(Debug, Default)]
|
|
pub struct WindowsAttributes {
|
|
window_icon_path: Option<PathBuf>,
|
|
/// A string containing an [application manifest] to be included with the application on Windows.
|
|
///
|
|
/// Defaults to:
|
|
/// ```text
|
|
#[doc = include_str!("window-app-manifest.xml")]
|
|
/// ```
|
|
///
|
|
/// ## Warning
|
|
///
|
|
/// if you are using tauri's dialog APIs, you need to specify a dependency on Common Control v6 by adding the following to your custom manifest:
|
|
/// ```text
|
|
/// <dependency>
|
|
/// <dependentAssembly>
|
|
/// <assemblyIdentity
|
|
/// type="win32"
|
|
/// name="Microsoft.Windows.Common-Controls"
|
|
/// version="6.0.0.0"
|
|
/// processorArchitecture="*"
|
|
/// publicKeyToken="6595b64144ccf1df"
|
|
/// language="*"
|
|
/// />
|
|
/// </dependentAssembly>
|
|
/// </dependency>
|
|
/// ```
|
|
///
|
|
/// [application manifest]: https://learn.microsoft.com/en-us/windows/win32/sbscs/application-manifests
|
|
app_manifest: Option<String>,
|
|
}
|
|
|
|
impl WindowsAttributes {
|
|
/// Creates the default attribute set.
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
/// Sets the icon to use on the window. Currently only used on Windows.
|
|
/// It must be in `ico` format. Defaults to `icons/icon.ico`.
|
|
#[must_use]
|
|
pub fn window_icon_path<P: AsRef<Path>>(mut self, window_icon_path: P) -> Self {
|
|
self
|
|
.window_icon_path
|
|
.replace(window_icon_path.as_ref().into());
|
|
self
|
|
}
|
|
|
|
/// Sets the [application manifest] to be included with the application on Windows.
|
|
///
|
|
/// Defaults to:
|
|
/// ```text
|
|
#[doc = include_str!("window-app-manifest.xml")]
|
|
/// ```
|
|
///
|
|
/// ## Warning
|
|
///
|
|
/// if you are using tauri's dialog APIs, you need to specify a dependency on Common Control v6 by adding the following to your custom manifest:
|
|
/// ```text
|
|
/// <dependency>
|
|
/// <dependentAssembly>
|
|
/// <assemblyIdentity
|
|
/// type="win32"
|
|
/// name="Microsoft.Windows.Common-Controls"
|
|
/// version="6.0.0.0"
|
|
/// processorArchitecture="*"
|
|
/// publicKeyToken="6595b64144ccf1df"
|
|
/// language="*"
|
|
/// />
|
|
/// </dependentAssembly>
|
|
/// </dependency>
|
|
/// ```
|
|
///
|
|
/// # Example
|
|
///
|
|
/// The following manifest will brand the exe as requesting administrator privileges.
|
|
/// Thus, everytime it is executed, a Windows UAC dialog will appear.
|
|
///
|
|
/// ```rust,no_run
|
|
/// let mut windows = tauri_build::WindowsAttributes::new();
|
|
/// windows = windows.app_manifest(r#"
|
|
/// <assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
|
|
/// <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
|
|
/// <security>
|
|
/// <requestedPrivileges>
|
|
/// <requestedExecutionLevel level="requireAdministrator" uiAccess="false" />
|
|
/// </requestedPrivileges>
|
|
/// </security>
|
|
/// </trustInfo>
|
|
/// </assembly>
|
|
/// "#);
|
|
/// let attrs = tauri_build::Attributes::new().windows_attributes(windows);
|
|
/// tauri_build::try_build(attrs).expect("failed to run build script");
|
|
/// ```
|
|
///
|
|
/// Note that you can move the manifest contents to a separate file and use `include_str!("manifest.xml")`
|
|
/// instead of the inline string.
|
|
///
|
|
/// [manifest]: https://learn.microsoft.com/en-us/windows/win32/sbscs/application-manifests
|
|
#[must_use]
|
|
pub fn app_manifest<S: AsRef<str>>(mut self, manifest: S) -> Self {
|
|
self.app_manifest = Some(manifest.as_ref().to_string());
|
|
self
|
|
}
|
|
}
|
|
|
|
/// The attributes used on the build.
|
|
#[derive(Debug, Default)]
|
|
pub struct Attributes {
|
|
#[allow(dead_code)]
|
|
windows_attributes: WindowsAttributes,
|
|
}
|
|
|
|
impl Attributes {
|
|
/// Creates the default attribute set.
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
/// Sets the icon to use on the window. Currently only used on Windows.
|
|
#[must_use]
|
|
pub fn windows_attributes(mut self, windows_attributes: WindowsAttributes) -> Self {
|
|
self.windows_attributes = windows_attributes;
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Run all build time helpers for your Tauri Application.
|
|
///
|
|
/// The current helpers include the following:
|
|
/// * Generates a Windows Resource file when targeting Windows.
|
|
///
|
|
/// # Platforms
|
|
///
|
|
/// [`build()`] should be called inside of `build.rs` regardless of the platform:
|
|
/// * New helpers may target more platforms in the future.
|
|
/// * Platform specific code is handled by the helpers automatically.
|
|
/// * A build script is required in order to activate some cargo environmental variables that are
|
|
/// used when generating code and embedding assets - so [`build()`] may as well be called.
|
|
///
|
|
/// In short, this is saying don't put the call to [`build()`] behind a `#[cfg(windows)]`.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// If any of the build time helpers fail, they will [`std::panic!`] with the related error message.
|
|
/// This is typically desirable when running inside a build script; see [`try_build`] for no panics.
|
|
pub fn build() {
|
|
if let Err(error) = try_build(Attributes::default()) {
|
|
let error = format!("{error:#}");
|
|
println!("{error}");
|
|
if error.starts_with("unknown field") {
|
|
print!("found an unknown configuration field. This usually means that you are using a CLI version that is newer than `tauri-build` and is incompatible. ");
|
|
println!(
|
|
"Please try updating the Rust crates by running `cargo update` in the Tauri app folder."
|
|
);
|
|
}
|
|
std::process::exit(1);
|
|
}
|
|
}
|
|
|
|
/// Non-panicking [`build()`].
|
|
#[allow(unused_variables)]
|
|
pub fn try_build(attributes: Attributes) -> Result<()> {
|
|
use anyhow::anyhow;
|
|
|
|
println!("cargo:rerun-if-env-changed=TAURI_CONFIG");
|
|
println!("cargo:rerun-if-changed=tauri.conf.json");
|
|
#[cfg(feature = "config-json5")]
|
|
println!("cargo:rerun-if-changed=tauri.conf.json5");
|
|
#[cfg(feature = "config-toml")]
|
|
println!("cargo:rerun-if-changed=Tauri.toml");
|
|
|
|
let target_os = std::env::var("CARGO_CFG_TARGET_OS").unwrap();
|
|
let mobile = target_os == "ios" || target_os == "android";
|
|
cfg_alias("desktop", !mobile);
|
|
cfg_alias("mobile", mobile);
|
|
|
|
let mut config = serde_json::from_value(tauri_utils::config::parse::read_from(
|
|
tauri_utils::platform::Target::from_triple(&std::env::var("TARGET").unwrap()),
|
|
std::env::current_dir().unwrap(),
|
|
)?)?;
|
|
if let Ok(env) = std::env::var("TAURI_CONFIG") {
|
|
let merge_config: serde_json::Value = serde_json::from_str(&env)?;
|
|
json_patch::merge(&mut config, &merge_config);
|
|
}
|
|
let config: Config = serde_json::from_value(config)?;
|
|
|
|
let s = config.tauri.bundle.identifier.split('.');
|
|
let last = s.clone().count() - 1;
|
|
let mut android_package_prefix = String::new();
|
|
for (i, w) in s.enumerate() {
|
|
if i == 0 || i != last {
|
|
android_package_prefix.push_str(w);
|
|
android_package_prefix.push('_');
|
|
}
|
|
}
|
|
android_package_prefix.pop();
|
|
println!("cargo:rustc-env=TAURI_ANDROID_PACKAGE_PREFIX={android_package_prefix}");
|
|
|
|
if let Some(project_dir) = var_os("TAURI_ANDROID_PROJECT_PATH").map(PathBuf::from) {
|
|
mobile::generate_gradle_files(project_dir)?;
|
|
}
|
|
|
|
cfg_alias("dev", !has_feature("custom-protocol"));
|
|
|
|
let ws_path = get_workspace_dir()?;
|
|
let mut manifest =
|
|
Manifest::<cargo_toml::Value>::from_slice_with_metadata(&std::fs::read("Cargo.toml")?)?;
|
|
|
|
if let Ok(ws_manifest) = Manifest::from_path(ws_path.join("Cargo.toml")) {
|
|
Manifest::complete_from_path_and_workspace(
|
|
&mut manifest,
|
|
Path::new("Cargo.toml"),
|
|
Some((&ws_manifest, ws_path.as_path())),
|
|
)?;
|
|
} else {
|
|
Manifest::complete_from_path(&mut manifest, Path::new("Cargo.toml"))?;
|
|
}
|
|
|
|
allowlist::check(&config, &mut manifest)?;
|
|
|
|
let target_triple = std::env::var("TARGET").unwrap();
|
|
|
|
println!("cargo:rustc-env=TAURI_ENV_TARGET_TRIPLE={target_triple}");
|
|
|
|
let out_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap());
|
|
// TODO: far from ideal, but there's no other way to get the target dir, see <https://github.com/rust-lang/cargo/issues/5457>
|
|
let target_dir = out_dir
|
|
.parent()
|
|
.unwrap()
|
|
.parent()
|
|
.unwrap()
|
|
.parent()
|
|
.unwrap();
|
|
|
|
if let Some(paths) = &config.tauri.bundle.external_bin {
|
|
copy_binaries(
|
|
ResourcePaths::new(external_binaries(paths, &target_triple).as_slice(), true),
|
|
&target_triple,
|
|
target_dir,
|
|
manifest.package.as_ref().map(|p| &p.name),
|
|
)?;
|
|
}
|
|
|
|
#[allow(unused_mut, clippy::redundant_clone)]
|
|
let mut resources = config.tauri.bundle.resources.clone().unwrap_or_default();
|
|
if target_triple.contains("windows") {
|
|
if let Some(fixed_webview2_runtime_path) =
|
|
&config.tauri.bundle.windows.webview_fixed_runtime_path
|
|
{
|
|
resources.push(fixed_webview2_runtime_path.display().to_string());
|
|
}
|
|
}
|
|
copy_resources(ResourcePaths::new(resources.as_slice(), true), target_dir)?;
|
|
|
|
if target_triple.contains("darwin") {
|
|
if let Some(version) = &config.tauri.bundle.macos.minimum_system_version {
|
|
println!("cargo:rustc-env=MACOSX_DEPLOYMENT_TARGET={version}");
|
|
}
|
|
}
|
|
|
|
if target_triple.contains("windows") {
|
|
use semver::Version;
|
|
use tauri_winres::{VersionInfo, WindowsResource};
|
|
|
|
fn find_icon<F: Fn(&&String) -> bool>(config: &Config, predicate: F, default: &str) -> PathBuf {
|
|
let icon_path = config
|
|
.tauri
|
|
.bundle
|
|
.icon
|
|
.iter()
|
|
.find(|i| predicate(i))
|
|
.cloned()
|
|
.unwrap_or_else(|| default.to_string());
|
|
icon_path.into()
|
|
}
|
|
|
|
let window_icon_path = attributes
|
|
.windows_attributes
|
|
.window_icon_path
|
|
.unwrap_or_else(|| find_icon(&config, |i| i.ends_with(".ico"), "icons/icon.ico"));
|
|
|
|
if target_triple.contains("windows") {
|
|
if window_icon_path.exists() {
|
|
let mut res = WindowsResource::new();
|
|
|
|
if let Some(manifest) = attributes.windows_attributes.app_manifest {
|
|
res.set_manifest(&manifest);
|
|
} else {
|
|
res.set_manifest(include_str!("window-app-manifest.xml"));
|
|
}
|
|
|
|
if let Some(version_str) = &config.package.version {
|
|
if let Ok(v) = Version::parse(version_str) {
|
|
let version = v.major << 48 | v.minor << 32 | v.patch << 16;
|
|
res.set_version_info(VersionInfo::FILEVERSION, version);
|
|
res.set_version_info(VersionInfo::PRODUCTVERSION, version);
|
|
}
|
|
res.set("FileVersion", version_str);
|
|
res.set("ProductVersion", version_str);
|
|
}
|
|
if let Some(product_name) = &config.package.product_name {
|
|
res.set("ProductName", product_name);
|
|
}
|
|
if let Some(short_description) = &config.tauri.bundle.short_description {
|
|
res.set("FileDescription", short_description);
|
|
}
|
|
if let Some(copyright) = &config.tauri.bundle.copyright {
|
|
res.set("LegalCopyright", copyright);
|
|
}
|
|
res.set_icon_with_id(&window_icon_path.display().to_string(), "32512");
|
|
res.compile().with_context(|| {
|
|
format!(
|
|
"failed to compile `{}` into a Windows Resource file during tauri-build",
|
|
window_icon_path.display()
|
|
)
|
|
})?;
|
|
} else {
|
|
return Err(anyhow!(format!(
|
|
"`{}` not found; required for generating a Windows Resource file during tauri-build",
|
|
window_icon_path.display()
|
|
)));
|
|
}
|
|
}
|
|
|
|
let target_env = std::env::var("CARGO_CFG_TARGET_ENV").unwrap();
|
|
match target_env.as_str() {
|
|
"gnu" => {
|
|
let target_arch = match std::env::var("CARGO_CFG_TARGET_ARCH").unwrap().as_str() {
|
|
"x86_64" => Some("x64"),
|
|
"x86" => Some("x86"),
|
|
"aarch64" => Some("arm64"),
|
|
arch => None,
|
|
};
|
|
if let Some(target_arch) = target_arch {
|
|
for entry in std::fs::read_dir(target_dir.join("build"))? {
|
|
let path = entry?.path();
|
|
let webview2_loader_path = path
|
|
.join("out")
|
|
.join(target_arch)
|
|
.join("WebView2Loader.dll");
|
|
if path.to_string_lossy().contains("webview2-com-sys") && webview2_loader_path.exists()
|
|
{
|
|
std::fs::copy(webview2_loader_path, target_dir.join("WebView2Loader.dll"))?;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
"msvc" => {
|
|
if std::env::var("STATIC_VCRUNTIME").map_or(false, |v| v == "true") {
|
|
static_vcruntime::build();
|
|
}
|
|
}
|
|
_ => (),
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[derive(serde::Deserialize)]
|
|
struct CargoMetadata {
|
|
workspace_root: PathBuf,
|
|
}
|
|
|
|
fn get_workspace_dir() -> Result<PathBuf> {
|
|
let output = std::process::Command::new("cargo")
|
|
.args(["metadata", "--no-deps", "--format-version", "1"])
|
|
.output()?;
|
|
|
|
if !output.status.success() {
|
|
return Err(anyhow::anyhow!(
|
|
"cargo metadata command exited with a non zero exit code: {}",
|
|
String::from_utf8(output.stderr)?
|
|
));
|
|
}
|
|
|
|
Ok(serde_json::from_slice::<CargoMetadata>(&output.stdout)?.workspace_root)
|
|
}
|