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

#![allow(non_snake_case)]

use super::Target;
use anyhow::{Result, bail};
use camino_fs::*;
use serde::Deserialize;
use std::str::FromStr;

#[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum LibType {
    StaticLib,
    CDyLib,
}

impl FromStr for LibType {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "staticlib" => Ok(LibType::StaticLib),
            "cdylib" => Ok(LibType::CDyLib),
            _ => Err(format!("Unknown lib type: {}", s)),
        }
    }
}

impl LibType {
    pub fn file_ending(&self) -> &'static str {
        match self {
            LibType::StaticLib => "a",
            LibType::CDyLib => "dylib",
        }
    }
}

#[derive(Deserialize, Debug, Default)]
#[serde(rename_all = "kebab-case")]
pub struct XCFrameworkConfiguration {
    /// The include directory containing the headers and the module.modulemap file
    /// This is set to default because sometimes it needs to be set manually after
    /// parsing the config.
    #[serde(default)]
    pub include_dir: Utf8PathBuf,

    /// The library type (staticlib or cdylib)
    /// only necessary if the package lib target defines both
    pub lib_type: Option<LibType>,

    /// Whether to zip the resulting XCFramework
    #[serde(default = "zip_default")]
    pub zip: bool,

    /// Enable Cargo to compile the standard library itself as part of a crate graph compilation.
    #[serde(default)]
    pub build_std: bool,

    #[serde(default)]
    pub macOS: bool,

    #[serde(default = "Target::default_macos")]
    pub macOS_targets: Vec<Target>,

    #[serde(default)]
    pub simulators: bool,

    #[serde(default)]
    pub iOS: bool,

    #[serde(default = "Target::default_ios")]
    pub iOS_targets: Vec<Target>,

    #[serde(default = "Target::default_ios_sim")]
    pub iOS_simulator_targets: Vec<Target>,
}

pub fn zip_default() -> bool {
    false
}

impl XCFrameworkConfiguration {
    pub fn chosen_targets(&self) -> Vec<Target> {
        let mut all = vec![];
        if self.macOS {
            all.extend(self.macOS_targets.iter());
        }
        if self.iOS {
            all.extend(self.iOS_targets.iter());
            if self.simulators {
                all.extend(self.iOS_simulator_targets.iter());
            }
        }
        all
    }

    /// Parses the [package.metadata.xcframework] section of the Cargo.toml
    /// and updates the headers_directory to be relative to current working directory
    pub fn parse(
        section: &serde_json::Value,
        package_dir: &Utf8Path,
        validate: bool,
    ) -> Result<Self> {
        let mut me = serde_json::from_value::<Self>(section.clone())?;
        me.include_dir = package_dir.join(me.include_dir);
        if validate { me.validated() } else { Ok(me) }
    }

    fn validated(self) -> Result<Self> {
        if self.include_dir.as_str().is_empty() {
            bail!("The include-dir field is required");
        }

        if !self.include_dir.exists() {
            bail!("The include-dir '{}' does not exist", self.include_dir);
        }

        if !self.iOS && !self.macOS {
            bail!("Nothing to build. At least one the fields 'iOS' or 'macOS' must be set to true");
        }
        Ok(self)
    }
}