xcframework 0.2.1

A Cargo plugin and library for building Apple XCFrameworks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use crate::cmd::modulemap;
use anyhow::{Context, Result, anyhow, bail};
use camino_fs::Utf8PathBuf;
use cargo_metadata::{Metadata, MetadataCommand, Package, TargetKind};

use super::{CliArgs, LibType, XCFrameworkConfiguration};

#[derive(Debug)]
pub struct Configuration {
    pub cargo_section: XCFrameworkConfiguration,
    pub cli: CliArgs,
    pub lib_type: LibType,
    // Name of the library (used for the compiled artifacts)
    pub lib_name: String,
    /// Directory for all generated artifacts
    pub target_dir: Utf8PathBuf,
    /// Directory where the xcframework will be built
    pub build_dir: Utf8PathBuf,
}

impl Configuration {
    pub fn new(
        metadata: &Metadata,
        package: &Package,
        mut cli: CliArgs,
        xc_conf: XCFrameworkConfiguration,
    ) -> Result<Self> {
        // Use the target directory from the CLI, or the one from the Cargo.toml
        let target_dir = cli
            .target_dir
            .as_ref()
            .unwrap_or(&metadata.target_directory)
            .clone();

        let build_dir = target_dir.join("xcframework");
        let wanted_lib_type = cli.lib_type.clone().or_else(|| xc_conf.lib_type.clone());

        let (lib_type, target) = get_libtype(package, wanted_lib_type)?;

        if xc_conf.build_std && lib_type == LibType::StaticLib {
            let already_set = cli
                .unstable_flags
                .as_ref()
                .map(|f| f.contains("build-std=std"))
                .unwrap_or(false);
            if !already_set {
                if let Some(flag) = cli.unstable_flags.to_owned() {
                    cli.unstable_flags = Some(format!("{flag},build-std=std"));
                } else {
                    cli.unstable_flags = Some("build-std=std".to_string());
                }
            }
        }
        Ok(Self {
            cargo_section: xc_conf,
            cli,
            lib_type,
            lib_name: target.name.clone(),
            target_dir,
            build_dir,
        })
    }

    pub fn load(cli: CliArgs) -> Result<Self> {
        let manifest_path = cli
            .manifest_path
            .clone()
            .unwrap_or_else(|| Utf8PathBuf::from("Cargo.toml"));
        let mut dir = manifest_path.clone();
        dir.pop();

        let metadata = MetadataCommand::new().manifest_path(manifest_path).exec()?;

        let workspace_packages = metadata.workspace_packages();
        let package = if let Some(package) = &cli.package {
            workspace_packages
                .iter()
                .find(|p| p.name.as_str() == package)
                .ok_or(anyhow!("Could not find package '{package}'"))?
        } else {
            metadata
                .root_package()
                .ok_or(anyhow!("Could not find root package in metadata"))?
        };

        let Some(section) = package.metadata.get("xcframework") else {
            bail!("Missing [package.metadata.xcframework] section in Cargo.toml");
        };

        let xc_conf = XCFrameworkConfiguration::parse(section, &dir, true)
            .context("Error in Cargo.toml section [package.metadata.xcframework]")?;

        Self::new(&metadata, package, cli, xc_conf)
    }

    pub fn module_name(&self) -> Result<String> {
        modulemap::get_module_name(self)
    }

    pub fn profile(&self) -> &str {
        if self.cli.release {
            "release"
        } else {
            self.cli.profile.as_deref().unwrap_or("debug")
        }
    }
}

fn get_libtype(
    package: &Package,
    libtype: Option<LibType>,
) -> Result<(LibType, &cargo_metadata::Target)> {
    let staticlib = package.targets.iter().find(|t| {
        t.kind.contains(&TargetKind::StaticLib) || t.kind.contains(&TargetKind::StaticLib)
    });
    let dylib = package
        .targets
        .iter()
        .find(|t| t.kind.contains(&TargetKind::CDyLib) || t.kind.contains(&TargetKind::CDyLib));
    use LibType::*;
    Ok(match (staticlib, dylib, libtype) {
        (Some(staticlib), None, None) => (StaticLib, staticlib),
        (Some(staticlib), _, Some(StaticLib)) => (StaticLib, staticlib),
        (Some(_staticlib), None, Some(CDyLib)) => {
            bail!("Please add 'cdylib' to '[lib] crate-type' in Cargo.toml")
        }
        (None, Some(dylib), None) => (CDyLib, dylib),
        (_, Some(dylib), Some(CDyLib)) => (CDyLib, dylib),
        (_, Some(_dylib), Some(StaticLib)) => {
            bail!("Please add 'staticlib' to '[lib] crate-type' in Cargo.toml")
        }
        (Some(_), Some(_), None) => {
            bail!("Please set '[package.metadata.xcframework] lib-type' in Cargo.toml")
        }
        (None, None, _) => bail!("Missing '[lib] crate-type' in Cargo.toml"),
    })
}