origen_metal 1.4.0

Bare metal APIs for the Origen SDK
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
use indexmap::IndexMap;
use crate::Result;
use lazy_static::lazy_static;

lazy_static! {
    static ref MULTI_PARAM_SEP: &'static str = "~:~";
    static ref NOT_PARSED_MSG: &'static str = "ParamStr has not yet been parsed!";
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParamStr {
    raw: Option<String>,
    parsed: Option<IndexMap<String, Vec<String>>>,
    leading: Option<String>,

    // Setup pieces
    allows_leading_str: bool,
    defaults: Option<(bool, IndexMap<String, Option<Vec<String>>>)>,
}

impl ParamStr {
    pub fn new(allows_leading_str: bool, defaults: Option<(bool, IndexMap<String, Option<Vec<String>>>)>) -> Self {
        Self {
            raw: None,
            parsed: None,
            leading: None,
            allows_leading_str,
            defaults,
        }
    }

    pub fn init_parsed(&mut self, allow_parsed: bool) -> Result<bool> {
        if self.parsed.is_some() {
            if allow_parsed {
                return Ok(false);
            } else {
                bail!("ParamStr has already been parsed. Please use 'param_str.clear()', before parsing new input");
            }
        }
        let mut parsed = IndexMap::new();
        if let Some(defs) = self.defaults.as_ref() {
            for (name, def_val) in &defs.1 {
                if let Some(v) = def_val {
                    parsed.insert(name.to_owned(), v.to_owned());
                }
            }
        }
        self.parsed = Some(parsed);
        Ok(true)
    }

    pub fn parse(&mut self, input: String) -> Result<&Self> {
        if self.parsed.is_some() {
            bail!("ParamStr has already been parsed. Please use 'param_str.clear()', before parsing new input");
        }
        let input_inter;
        let leading;
        let mut parsed = IndexMap::new();

        if input.contains(*MULTI_PARAM_SEP) {
            bail!("ParamStr input contains the multi-param-separate '{}', which is not allowed. Please use a MultiParamStr instead", *MULTI_PARAM_SEP);
        }

        // Handle the leading string
        if self.allows_leading_str {
            if let Some(split) = input.split_once("~") {
                leading = Some(split.0.to_string());
                input_inter = split.1.to_string();
            } else {
                leading = Some(input.clone());
                input_inter = "".to_string();
            }
        } else {
            leading = None;
            input_inter = input.clone();
        }

        if !input_inter.is_empty() {
            let allows_non_defaults;
            if let Some(defs) = self.defaults.as_ref() {
                allows_non_defaults = defs.0;
            } else {
                allows_non_defaults = true;
            }

            if input_inter.trim().starts_with(":") {
                if leading.is_some() {
                    // Something like blah~: was given. Use empty key message
                    bail!("ParamStr encountered a parameter with an empty key, which is not allowed");
                } else {
                    bail!("ParamStr found value separator as first character, which is not allowed");
                }
            }

            let mut found_leading_colon = false;
            for param_str in input_inter.split('~') {
                if found_leading_colon {
                    if param_str == "~" {
                        // encountered ~:~, which not allowed in a single param string
                        bail!("Encountered ParamStr split sequence ~:~ in a single ParamStr, which is not allowed. Please use a MultiParamStr or update the input for a single ParamStr");
                    } else {
                        // encountered ~:, which does not have a param key and not allowed
                        bail!("ParamStr encountered a parameter with a value separator but no key, which is not allowed");
                    }
                }
                if param_str == ":" {
                    found_leading_colon = true;
                    continue;
                } else if param_str.is_empty() {
                    bail!("ParamStr encountered a parameter with an empty key, which is not allowed")
                } else if param_str.trim().is_empty() {
                    bail!("ParamStr encountered a parameter of only whitespace, which is not allowed")
                }

                let k;
                macro_rules! check_key {
                    () => {
                        if !allows_non_defaults {
                            if !self.defaults.as_ref().unwrap().1.contains_key(&k) {
                                bail!("ParamStr encountered parameter '{}', which is not an expected parameter", k);
                            }
                        }
                        if parsed.contains_key(&k) {
                            bail!("ParamStr encountered a duplicate parameter '{}', which is not allowed", k);
                        }
                    }
                }

                let key_split = param_str.split_once(":");
                if let Some(split) = key_split {
                    k = split.0.to_string();
                    check_key!();
                    parsed.insert(
                        k,
                        split.1.split(":").map(|s| s.to_string()).collect::<Vec<String>>()
                    );
                } else {
                    k = param_str.to_owned();
                    check_key!();
                    parsed.insert(k, vec!());
                }
            }
            if found_leading_colon {
                bail!("ParamStr encountered a parameter with a value separator but no key, which is not allowed");
            }
        }

        // Fill in any missing defaults
        if let Some(defs) = self.defaults.as_ref() {
            for (n, def) in &defs.1 {
                if !parsed.contains_key(n) {
                    if let Some(d) = def {
                        parsed.insert(n.to_owned(), d.to_owned());
                    }
                }
            }
        }

        self.parsed = Some(parsed);
        self.leading = leading;
        self.raw = Some(input);
        Ok(self)
    }

    fn param_set(&mut self, param: String, val: Option<Vec<String>>) -> Result<bool> {
        match self.parsed.as_mut() {
            Some(params) => {
                let retn = params.contains_key(&param);
                if let Some(defs) = self.defaults.as_ref() {
                    if (!defs.0) && (!defs.1.contains_key(&param)) {
                        bail!("ParamStr encountered parameter '{}', which is not an expected parameter", &param);
                    }
                }
                if let Some(v) = val {
                    params.insert(param, v);
                } else {
                    params.remove(&param);
                }
                Ok(retn)
            },
            None => bail!(*NOT_PARSED_MSG)
        }
    }

    pub fn set_param(&mut self, param: String, val: Option<Vec<String>>) -> Result<bool> {
        if self.parsed.is_some() {
            self.param_set(param, val)
        } else {
            self.init_parsed(true)?;
            self.param_set(param, val)
        }
    }

    pub fn defaults(&self) -> Option<&IndexMap<String, Option<Vec<String>>>> {
        if let Some(defs) = self.defaults.as_ref() {
            Some(&defs.1)
        } else {
            None
        }
    }

    pub fn with_mut_defs<T, F>(&mut self, f: F) -> Result<T>
    where
        F: FnOnce(&mut (bool, IndexMap<String, Option<Vec<String>>>)) -> Result<T>,
    {
        if self.parsed.is_some() {
            bail!("Attempted to update ParamStr's default values after parsing, which is not allowed")
        }
        if self.defaults.is_none() {
            self.defaults = Some((false, IndexMap::new()));
        }
        f(self.defaults.as_mut().unwrap())
    }

    pub fn add_default(&mut self, def: String, value: Option<Vec<String>>) -> Result<bool> {
        self.with_mut_defs( |defs| {
            let retn = defs.1.contains_key(&def);
            defs.1.insert(def, value);
            Ok(retn)
        })
    }

    pub fn add_defaults(&mut self, to_add: IndexMap<String, Option<Vec<String>>>) -> Result<Vec<bool>> {
        self.with_mut_defs( |defs| {
            let mut retn = vec!();
            for (name, val) in to_add {
                retn.push(defs.1.contains_key(&name));
                defs.1.insert(name, val);
            }
            Ok(retn)
        })
    }

    pub fn remove_default(&mut self, to_remove: &str) -> Result<Option<Vec<String>>> {
        self.with_mut_defs( |defs| {
            match defs.1.shift_remove(to_remove) {
                Some(value) => Ok(value),
                None => bail!("No parameter '{}' to remove from ParamStr's defaults", to_remove)
            }
        })
    }

    pub fn remove_defaults(&mut self, to_remove: &Vec<String>) -> Result<Vec<Option<Vec<String>>>> {
        self.with_mut_defs( |defs| {
            // Check that all keys are valid first
            for name in to_remove {
                if !defs.1.contains_key(name) {
                    bail!("No parameter '{}' to remove from ParamStr's defaults", name)
                }
            }

            let mut retn = vec!();
            for name in to_remove {
                retn.push(defs.1.shift_remove(name).unwrap());
            }
            Ok(retn)
        })
    }

    pub fn allows_non_defaults(&self) -> Option<bool> {
        if let Some(setup) = self.defaults.as_ref() {
            Some(setup.0)
        } else {
            None
        }
    }

    pub fn set_allows_non_defaults(&mut self, new_val: bool) -> Result<()> {
        if self.parsed.is_some() {
            bail!("Cannot set ParamStr's allows_non_defaults with no default parameters");
        }
        self.with_mut_defs( |defs| {
            defs.0 = new_val;
            Ok(())
        })
    }

    pub fn parsed(&self) -> &Option<IndexMap<String, Vec<String>>> {
        &self.parsed
    }

    pub fn get_parsed(&self) -> Result<&IndexMap<String, Vec<String>>> {
        if let Some(parsed) = self.parsed.as_ref() {
            Ok(parsed)
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }

    pub fn clear(&mut self) -> Result<&mut Self> {
        self.parsed = None;
        self.leading = None;
        self.raw = None;
        Ok(self)
    }

    pub fn raw(&self) -> Result<&Option<String>> {
        if self.parsed.is_some() {
            Ok(&self.raw)
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }

    pub fn leading(&self) -> Result<&Option<String>> {
        if self.parsed.is_some() {
            Ok(&self.leading)
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }

    pub fn set_leading(&mut self, new_leading: Option<String>) -> Result<bool> {
        if !self.allows_leading_str {
            bail!("Attempted to set leading value but 'allows_leading_str' is not allowed")
        }
        self.init_parsed(true)?;
        let retn = self.leading.is_some();
        self.leading = new_leading;
        Ok(retn)
    }

    pub fn allows_leading_str(&self) -> bool {
        self.allows_leading_str
    }

    pub fn set_allows_leading_str(&mut self, new_val: bool) -> Result<()> {
        if self.parsed.is_some() {
            bail!("Attempted to change ParamStr's 'allows_leading_str' setting after parsing, which is not allowed");
        }
        self.allows_leading_str = new_val;
        Ok(())
    }

    pub fn get(&self, key: &str) -> Result<Option<&Vec<String>>> {
        if let Some(args) = self.parsed.as_ref() {
            Ok(args.get(key))
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }

    pub fn to_string(&self) -> Result<String> {
        if let Some(args) = self.parsed.as_ref() {
            let params = args.iter().map(|(k, v)| {
                if v.is_empty() {
                    k.clone()
                } else {
                    format!("{}:{}", k, v.join(":"))
                }
            }).collect::<Vec<String>>().join("~");
            if let Some(leading) = self.leading.as_ref() {
                if params.is_empty() {
                    Ok(leading.clone())
                } else {
                    Ok(format!("{}~{}", leading, params))
                }
            } else {
                Ok(params)
            }
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }

    pub fn keys(&self) -> Result<Vec<&String>> {
        if let Some(args) = self.parsed.as_ref() {
            Ok(args.keys().collect())
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }

    pub fn values(&self) -> Result<Vec<&Vec<String>>> {
        if let Some(args) = self.parsed.as_ref() {
            Ok(args.values().collect())
        } else {
            bail!(*NOT_PARSED_MSG);
        }
    }
}

pub struct MultiParamStr {
    param_strs: Vec<ParamStr>,
    allows_leading_str: bool,

    raw: Option<String>,
    parsed: Option<Vec<ParamStr>>,
    leading: Option<String>,
}

impl MultiParamStr {
    pub fn new(allows_leading_str: bool) -> Self {
        Self {
            param_strs: vec!(),
            allows_leading_str: allows_leading_str,

            raw: None,
            parsed: None,
            leading: None,
        }
    }

    pub fn new_with_leading() -> Self {
        Self {
            param_strs: vec!(),
            allows_leading_str: true,

            raw: None,
            parsed: None,
            leading: None,
        }
    }

    pub fn new_without_leading() -> Self {
        Self {
            param_strs: vec!(),
            allows_leading_str: false,

            raw: None,
            parsed: None,
            leading: None,
        }
    }

    pub fn parse(&mut self, input_str: String) -> Result<()> {
        let params: &str;
        let leading: Option<String>;
        let mut parsed: Vec<ParamStr> = vec!();

        if self.allows_leading_str {
            if let Some(split) = input_str.split_once(*MULTI_PARAM_SEP) {
                leading = Some(split.0.to_string());
                params = split.1;
            } else {
                leading = Some(input_str.to_string());
                params = "";
            }
        } else {
            leading = None;
            params = input_str.as_str();
        }

        if !params.is_empty() {
            // TODO support parsing into given ParamStrs
            for (_i, param_str) in params.split(*MULTI_PARAM_SEP).enumerate() {
                if self.param_strs.is_empty() {
                    // Individual ParamStrs from a multi-param string cannot have leading strings
                    let mut p = ParamStr::new(false, None);
                    p.parse(param_str.to_string())?;
                    parsed.push(p);
                } else {
                    todo!("Named ParamStrs not ready yet!");
                }
            }
        }

        self.leading = leading;
        self.parsed = Some(parsed);
        self.raw = Some(input_str);
        Ok(())
    }

    pub fn allows_leading_str(&self) -> bool {
        self.allows_leading_str
    }

    pub fn param_strs(&self) -> &Vec<ParamStr> {
        &self.param_strs
    }

    pub fn parsed(&self) -> &Option<Vec<ParamStr>> {
        &self.parsed
    }

    pub fn leading(&self) -> &Option<String> {
        &self.leading
    }

    pub fn raw(&self) -> &Option<String> {
        &self.raw
    }
}