apinotes 0.0.2

Parsing clang API notes
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

use std::path::Path;
use std::str::FromStr;

use serde::Deserialize;

use crate::map_helper::MapKey;
use crate::{Class, Enumerator, Error, Function, Global, Map, Protocol, Tag, Typedef};

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[non_exhaustive]
pub struct ApiNotes {
    pub name: String,
    #[serde(default)]
    #[serde(with = "crate::map_helper")]
    pub swift_versions: Map<Version, Data>,
    #[serde(flatten)]
    pub data: Data,
}

impl ApiNotes {
    pub fn from_path(path: &Path) -> Result<Self, Error> {
        let contents = std::fs::read_to_string(path).expect("todo");

        Self::from_str(&contents)
    }
}

impl FromStr for ApiNotes {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        serde_yaml::from_str(s).map_err(Error::from_yaml)
    }
}

#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize)]
#[non_exhaustive]
pub enum Version {
    V3,
    V4,
    V4_2,
    V5,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub(crate) struct VersionHelper {
    version: f32,
}

impl<'de> MapKey<'de> for Version {
    type Inner = VersionHelper;
    fn from_inner(inner: Self::Inner) -> Self {
        if inner.version == 3.0 {
            Version::V3
        } else if inner.version == 4.0 {
            Version::V4
        } else if inner.version == 4.2 {
            Version::V4_2
        } else if inner.version == 5.0 {
            Version::V5
        } else {
            panic!("unknown version {}", inner.version)
        }
    }
    const CONTAIN_ERROR: &'static str = "a `Version` attribute";
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Data {
    #[serde(with = "crate::map_helper")]
    pub classes: Map<String, Class>,
    #[serde(with = "crate::map_helper")]
    pub protocols: Map<String, Protocol>,
    #[serde(with = "crate::map_helper")]
    pub tags: Map<String, Tag>,
    #[serde(with = "crate::map_helper")]
    pub typedefs: Map<String, Typedef>,
    #[serde(with = "crate::map_helper")]
    pub globals: Map<String, Global>,
    #[serde(with = "crate::map_helper")]
    pub enumerators: Map<String, Enumerator>,
    #[serde(with = "crate::map_helper")]
    pub functions: Map<String, Function>,
}