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
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

use serde::Deserialize;

use crate::{
    General, Map, Method, MethodKey, Nullability, Parameter, Position, Property, PropertyKey, Type,
};

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Class {
    #[serde(flatten)]
    pub general: General,
    #[serde(with = "crate::map_helper")]
    pub methods: Map<MethodKey, Method>,
    #[serde(with = "crate::map_helper")]
    pub properties: Map<PropertyKey, Property>,
    pub swift_bridge: Option<String>,
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Protocol {
    #[serde(flatten)]
    pub general: General,
    #[serde(with = "crate::map_helper")]
    pub methods: Map<MethodKey, Method>,
    #[serde(with = "crate::map_helper")]
    pub properties: Map<PropertyKey, Property>,
}

#[derive(Clone, Debug, PartialEq, Deserialize)]
pub enum EnumKind {
    #[serde(alias = "CFEnum")]
    NSEnum,
    #[serde(alias = "CFClosedEnum")]
    NSClosedEnum,
    #[serde(alias = "CFOptions")]
    NSOptions,
    #[serde(rename = "none")]
    None,
}

/// Structs, enums, and unions.
#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Tag {
    #[serde(flatten)]
    pub general: General,
    /// Only used on enums.
    #[serde(rename = "NSErrorDomain")]
    pub error_domain: Option<String>,
    /// Only used on enums.
    pub enum_kind: Option<EnumKind>,
}

#[derive(Clone, Debug, PartialEq, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum SwiftWrapper {
    Struct,
    Enum,
    None,
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Typedef {
    #[serde(flatten)]
    pub general: General,
    pub swift_wrapper: Option<SwiftWrapper>,
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Global {
    #[serde(flatten)]
    pub general: General,
    pub nullability: Option<Nullability>,
    #[serde(rename = "Type")]
    pub type_: Option<Type>,
}

/// Enum cases.
#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Enumerator {
    #[serde(flatten)]
    pub general: General,
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Function {
    #[serde(flatten)]
    pub general: General,
    /// Note: May not work due to compiler bugs
    pub nullability_of_ret: Option<Nullability>,
    pub result_type: Option<Type>,
    #[serde(with = "crate::map_helper")]
    pub parameters: Map<Position, Parameter>,
    // pub retain_count_convention:
}