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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
use crate::ffi::enums::ChoiceListType;
use crate::ffi::{KeyFrame, ParmChoiceInfo, ParmInfo};
use crate::node::{NodeHandle, ParmType};
use crate::session::Session;
use crate::Result;
use std::borrow::Cow;
use std::ffi::{CStr, CString};
use std::ops::Deref;

use super::Parameter;

/// Common trait for parameters
pub trait ParmBaseTrait {
    #[inline]
    fn name(&self) -> Result<Cow<str>> {
        let inner = self.inner();
        match inner.info.name.as_ref() {
            None => inner.info.name().map(Cow::Owned),
            Some(c_name) => Ok(c_name.to_string_lossy()),
        }
    }

    #[inline]
    fn session(&self) -> &Session {
        &self.info().session
    }

    #[inline]
    fn node(&self) -> NodeHandle {
        self.inner().node
    }

    #[inline]
    fn size(&self) -> i32 {
        self.info().size()
    }

    #[inline]
    fn info(&self) -> &ParmInfo {
        &self.inner().info
    }

    /// Update the internal parameter metadata if Houdini parameter changed,
    /// for example children added to a multi-parm or the menu was updated.
    fn update(&mut self) -> Result<()> {
        let inner = self.inner_mut();
        let name = inner.info.name.take();
        let mut info =
            ParmInfo::from_parm_handle(inner.info.id(), inner.node, &inner.info.session)?;
        info.name = name;
        inner.info = info;
        Ok(())
    }

    /// If the parameter has choice menu.
    #[inline]
    fn is_menu(&self) -> bool {
        !matches!(self.info().choice_list_type(), ChoiceListType::None)
    }
    /// If parameter is a menu type, return a vec of menu items
    fn menu_items(&self) -> Result<Option<Vec<ParmChoiceInfo>>> {
        if !self.is_menu() {
            return Ok(None);
        }
        let inner = self.inner();
        debug_assert!(inner.info.session.is_valid());
        if inner.info.choice_count() == 0 {
            return Ok(Some(Vec::new()));
        }
        let parms = crate::ffi::get_parm_choice_list(
            inner.node,
            &inner.info.session,
            inner.info.choice_index(),
            inner.info.choice_count(),
        );
        let parms = parms.map(|v| {
            v.into_iter()
                .map(|p| ParmChoiceInfo {
                    inner: p,
                    session: inner.info.session.deref().clone(),
                })
                .collect::<Vec<ParmChoiceInfo>>()
        })?;
        Ok(Some(parms))
    }

    /// If the parameter is a multiparm, return its children parms.
    /// NOTE: THis is not a recommended way to traverse parameters in general,
    /// this is here for convenience only
    fn multiparm_children(&self) -> Result<Option<Vec<Parameter>>> {
        let inner = self.inner();
        if inner.info.parm_type() != ParmType::Multiparmlist {
            return Ok(None);
        }
        let node = inner.node.to_node(&inner.info.session)?;
        let mut all_parameters = node.parameters()?;
        all_parameters.retain(|parm| {
            parm.info().is_child_of_multi_parm() && parm.info().parent_id() == inner.info.id()
        });

        Ok(Some(all_parameters))
    }

    /// Returns a parameter expression string
    fn expression(&self, index: i32) -> Result<Option<String>> {
        let inner = self.inner();
        debug_assert!(inner.info.session.is_valid());
        let name = self.c_name()?;
        crate::ffi::get_parm_expression(inner.node, &inner.info.session, &name, index)
    }

    /// Checks if parameter has an expression
    fn has_expression(&self, index: i32) -> Result<bool> {
        let inner = self.inner();
        debug_assert!(inner.info.session.is_valid());
        let name = self.c_name()?;
        crate::ffi::parm_has_expression(inner.node, &inner.info.session, &name, index)
    }

    /// Set parameter expression
    fn set_expression(&self, value: &str, index: i32) -> Result<()> {
        let inner = self.inner();
        debug_assert!(inner.info.session.is_valid());
        let value = CString::new(value)?;
        crate::ffi::set_parm_expression(
            inner.node,
            &inner.info.session,
            inner.info.id(),
            &value,
            index,
        )
    }

    /// Remove parameter expression
    fn remove_expression(&self, index: i32) -> Result<()> {
        let inner = self.inner();
        debug_assert!(inner.info.session.is_valid());
        crate::ffi::remove_parm_expression(inner.node, &inner.info.session, inner.info.id(), index)
    }

    /// Revert parameter at index to its default value. If `index` is None - reset all instances.
    fn revert_to_default(&self, index: Option<i32>) -> Result<()> {
        let inner = self.inner();
        crate::ffi::revert_parameter_to_default(
            inner.node,
            &inner.info.session,
            &self.c_name()?,
            index,
        )
    }

    /// Set keyframes on the parameter
    fn set_anim_curve(&self, index: i32, keys: &[KeyFrame]) -> Result<()> {
        let inner = self.inner();
        debug_assert!(inner.info.session.is_valid());
        // SAFETY: Both structures have the same memory layout.
        let keys =
            unsafe { std::mem::transmute::<&[KeyFrame], &[crate::ffi::raw::HAPI_Keyframe]>(keys) };
        crate::ffi::set_parm_anim_curve(
            &inner.info.session,
            inner.node,
            inner.info.id(),
            index,
            keys,
        )
    }

    fn has_tag(&self, tag: &str) -> Result<bool> {
        let inner = self.inner();
        let tag = CString::new(tag)?;
        crate::ffi::parm_has_tag(&inner.info.session, inner.node, inner.info.id(), &tag)
    }

    /// Get parameter tag name by index. The number of tags is stored in `self.info().tag_count()`
    fn get_tag_name(&self, tag_index: i32) -> Result<String> {
        let inner = self.inner();
        crate::ffi::get_parm_tag_name(&inner.info.session, inner.node, inner.info.id(), tag_index)
    }

    fn get_tag_value(&self, tag_name: &str) -> Result<String> {
        let inner = self.inner();
        let tag = CString::new(tag_name)?;
        crate::ffi::get_parm_tag_value(&inner.info.session, inner.node, inner.info.id(), &tag)
    }

    #[doc(hidden)]
    // If the parameter was obtained by name (node.parameter(..))
    // we store the name in the info struct, otherwise, call API to get name
    fn c_name(&self) -> Result<Cow<CStr>> {
        let inner = self.inner();
        match inner.info.name.as_deref() {
            None => inner.info.name_cstr().map(Cow::Owned),
            Some(name) => Ok(Cow::Borrowed(name)),
        }
    }
    #[doc(hidden)]
    fn inner(&self) -> &ParmInfoWrap;

    #[doc(hidden)]
    fn inner_mut(&mut self) -> &mut ParmInfoWrap;
}

#[derive(Debug)]
#[doc(hidden)]
pub struct ParmInfoWrap {
    pub(crate) info: ParmInfo,
    pub(crate) node: NodeHandle,
}

#[derive(Debug)]
#[doc(hidden)]
pub struct BaseParameter(pub(crate) ParmInfoWrap);

/// Represents float parameters, including `Color` type.
#[derive(Debug)]
pub struct FloatParameter(pub(crate) ParmInfoWrap);

/// Represents integer parameters, including `Button` type
#[derive(Debug)]
pub struct IntParameter(pub(crate) ParmInfoWrap);

/// Represents string parameters of many different types.
#[derive(Debug)]
pub struct StringParameter(pub(crate) ParmInfoWrap);

impl ParmBaseTrait for FloatParameter {
    #[inline]
    #[doc(hidden)]
    fn inner(&self) -> &ParmInfoWrap {
        &self.0
    }

    #[inline]
    #[doc(hidden)]
    fn inner_mut(&mut self) -> &mut ParmInfoWrap {
        &mut self.0
    }
}

impl ParmBaseTrait for IntParameter {
    #[inline]
    #[doc(hidden)]
    fn inner(&self) -> &ParmInfoWrap {
        &self.0
    }

    #[inline]
    #[doc(hidden)]
    fn inner_mut(&mut self) -> &mut ParmInfoWrap {
        &mut self.0
    }
}

impl ParmBaseTrait for StringParameter {
    #[inline]
    #[doc(hidden)]
    fn inner(&self) -> &ParmInfoWrap {
        &self.0
    }

    #[inline]
    #[doc(hidden)]
    fn inner_mut(&mut self) -> &mut ParmInfoWrap {
        &mut self.0
    }
}