clack-common 0.2.0

Various utilities for working with the CLAP audio plugin API, for both plugins and hosts.
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use clap_sys::version::clap_version;
use std::cmp::Ordering;
use std::fmt::{Display, Formatter};

/// A CLAP version identifier.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub struct ClapVersion {
    /// The major version number.
    ///
    /// A change in this number indicates an incompatible ABI or API change.
    ///
    /// Version `0.x.y` is the development stage, and ABI or API stability is not guaranteed.
    pub major: u32,

    /// The minor version number.
    ///
    /// A change in this number indicates a compatible API extension.
    pub minor: u32,

    /// The revision version number.
    ///
    /// A change in this number indicates a bug fix or other compatible change.
    pub revision: u32,
}

impl ClapVersion {
    /// The version of the CLAP API that is implemented by this Clack implementation.
    pub const CURRENT: ClapVersion = Self::from_raw(clap_sys::version::CLAP_VERSION);

    /// Creates a [`ClapVersion`] from its raw, C-FFI compatible representation.
    #[inline]
    pub const fn from_raw(raw: clap_version) -> Self {
        Self {
            major: raw.major,
            minor: raw.minor,
            revision: raw.revision,
        }
    }

    /// Returns this [`ClapVersion`] as its raw, C-FFI compatible representation.
    #[inline]
    pub const fn to_raw(self) -> clap_version {
        clap_version {
            major: self.major,
            minor: self.minor,
            revision: self.revision,
        }
    }

    /// Returns whether this [`ClapVersion`] is compatible with the current version of this `clack`
    /// library.
    ///
    /// This currently returns true if this version's `major` field is `1`, and false
    /// otherwise.
    #[inline]
    pub const fn is_compatible(&self) -> bool {
        clap_sys::version::clap_version_is_compatible(self.to_raw())
    }
}

impl PartialOrd for ClapVersion {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for ClapVersion {
    fn cmp(&self, other: &Self) -> Ordering {
        match self.major.cmp(&other.major) {
            Ordering::Equal => match self.minor.cmp(&other.minor) {
                Ordering::Equal => self.revision.cmp(&other.revision),
                o => o,
            },
            o => o,
        }
    }
}

impl Display for ClapVersion {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}.{}.{}", self.major, self.minor, self.revision)
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    pub fn display() {
        let version = ClapVersion {
            major: 1,
            minor: 5,
            revision: 3,
        };
        let display = format!("{version}");

        assert_eq!(&"1.5.3", &display);
    }

    #[test]
    pub fn version_ordering() {
        let version = ClapVersion {
            major: 1,
            minor: 5,
            revision: 3,
        };

        assert_eq!(
            version,
            ClapVersion {
                major: 1,
                minor: 5,
                revision: 3,
            }
        );

        assert!(
            version
                > ClapVersion {
                    major: 1,
                    minor: 4,
                    revision: 3
                }
        );

        assert!(
            version
                < ClapVersion {
                    major: 2,
                    minor: 1,
                    revision: 1
                }
        );

        assert!(
            version
                < ClapVersion {
                    major: 1,
                    minor: 5,
                    revision: 5
                }
        );

        assert_eq!(
            Ordering::Equal,
            version.cmp(&ClapVersion {
                major: 1,
                minor: 5,
                revision: 3
            })
        );
    }
}