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
484
485
486
487
#![allow(dead_code)]

use crate::{Signature, arg::TypeMismatchError};
use std::{fmt, any};
use std::sync::Arc;
use std::rc::Rc;

use super::{Iter, IterAppend, ArgType};

/// Types that can represent a D-Bus message argument implement this trait.
///
/// Types should also implement either Append or Get to be useful.
pub trait Arg {
    /// The corresponding D-Bus argument type code.
    const ARG_TYPE: ArgType;
    /// The corresponding D-Bus type signature for this type.
    fn signature() -> Signature<'static>;
}

/// Helper trait to introspect many arguments.
pub trait ArgAll {
    /// A tuple of &static str. Used for introspection.
    #[allow(non_camel_case_types)] // Note: This should be changed for 0.9 - but for now, don't break backwards compatibility
    type strs;
    /// Enumerates all arguments with their signatures (introspection helper method).
    fn strs_sig<F: FnMut(&'static str, Signature<'static>)>(a: Self::strs, f: F);
}

/// Types that can be appended to a message as arguments implement this trait.
pub trait Append {
    /// Performs the append operation by consuming self.
    fn append(self, ia: &mut IterAppend) where Self: Sized { self.append_by_ref(ia) }

    /// Performs the append operation by borrowing self.
    fn append_by_ref(&self, _: &mut IterAppend);
}

/// Helper trait to append many arguments to a message.
pub trait AppendAll {
    /// Performs the append operation by borrowing self.
    fn append(&self, _: &mut IterAppend);
}

/// Types that can be retrieved from a message as arguments implement this trait.
pub trait Get<'a>: Sized {
    /// Performs the get operation.
    fn get(i: &mut Iter<'a>) -> Option<Self>;
}

/// Helper trait to read all arguments from a message.
pub trait ReadAll: Sized {
    /// Performs the read operation.
    fn read(i: &mut Iter) -> Result<Self, TypeMismatchError>;
}


/// Object safe version of Arg + Append + Get.
pub trait RefArg: fmt::Debug {
    /// The corresponding D-Bus argument type code.
    fn arg_type(&self) -> ArgType;
    /// The corresponding D-Bus type signature for this type.
    fn signature(&self) -> Signature<'static>;
    /// Performs the append operation.
    fn append(&self, _: &mut IterAppend);
    /// Transforms this argument to Any (which can be downcasted to read the current value).
    ///
    /// If the type is an array, and the element type is byte, numeric, boolean, or string, then the
    /// representation is guaranteed to be a Vec<T>. Arrays of structs, dicts, and so on are not
    /// safe to use with this.
    ///
    /// Note: The internal representation of complex types (Dict, Struct) is unstable
    /// and as_any should not be relied upon for these types. Use as_iter instead.
    fn as_any(&self) -> &dyn any::Any where Self: 'static;
    /// Transforms this argument to Any (which can be downcasted to read the current value).
    ///
    /// If the type is an array, and the element type is byte, numeric, boolean, or string, then the
    /// representation is guaranteed to be a Vec<T>. Arrays of structs, dicts, and so on are not
    /// safe to use with this.
    ///
    /// Note: The internal representation of complex types (Dict, Struct) is unstable
    /// and as_any should not be relied upon for these types. Use as_iter instead.
    ///
    /// # Panic
    /// Will panic if the interior cannot be made mutable, e g, if encapsulated
    /// inside a Rc with a reference count > 1.
    fn as_any_mut(&mut self) -> &mut dyn any::Any where Self: 'static;
    /// Try to read the argument as an i64.
    ///
    /// Works for: Boolean, Byte, Int16, UInt16, Int32, UInt32, Int64, UnixFd.
    #[inline]
    fn as_i64(&self) -> Option<i64> { None }
    /// Try to read the argument as an u64.
    ///
    /// Works for: Boolean, Byte, Int16, UInt16, Int32, UInt32, UInt64.
    #[inline]
    fn as_u64(&self) -> Option<u64> { None }
    /// Try to read the argument as an f64.
    ///
    /// Works for: Boolean, Byte, Int16, UInt16, Int32, UInt32, Double.
    #[inline]
    fn as_f64(&self) -> Option<f64> { None }
    /// Try to read the argument as a str.
    ///
    /// Works for: String, ObjectPath, Signature.
    #[inline]
    fn as_str(&self) -> Option<&str> { None }
    /// Try to read the argument as an iterator.
    ///
    /// Works for: Array/Dict, Struct, Variant.
    /// For Dicts, keys and values are interleaved.
    #[inline]
    fn as_iter<'a>(&'a self) -> Option<Box<dyn Iterator<Item=&'a dyn RefArg> + 'a>> { None }
    /// Try to read the inner of an argument, as another argument, specifying an index.
    ///
    /// Works for: Variant, Array, Struct, Dict.
    /// For Dicts, even indices gets a key, odd indices gets a value.
    #[inline]
    fn as_static_inner(&self, _index: usize) -> Option<&(dyn RefArg + 'static)> where Self: 'static { None }
    /// Deep clone of the RefArg, causing the result to be 'static.
    ///
    /// Usable as an escape hatch in case of lifetime problems with RefArg.
    ///
    /// In case of complex types (Array, Dict, Struct), the clone is not guaranteed
    /// to have the same internal representation as the original.
    fn box_clone(&self) -> Box<dyn RefArg + 'static> { unimplemented!() /* Needed for backwards comp */ }
}

impl<'a> Get<'a> for Box<dyn RefArg> {
    fn get(i: &mut Iter<'a>) -> Option<Self> { i.get_refarg() }
}

/// Cast a RefArg as a specific type (shortcut for any + downcast)
#[inline]
pub fn cast<'a, T: 'static>(a: &'a (dyn RefArg + 'static)) -> Option<&'a T> { a.as_any().downcast_ref() }

/// Cast a RefArg as a specific type (shortcut for any_mut + downcast_mut)
///
/// # Panic
/// Will panic if the interior cannot be made mutable, e g, if encapsulated
/// inside a Rc with a reference count > 1.
#[inline]
pub fn cast_mut<'a, T: 'static>(a: &'a mut (dyn RefArg + 'static)) -> Option<&'a mut T> { a.as_any_mut().downcast_mut() }

/// If a type implements this trait, it means the size and alignment is the same
/// as in D-Bus. This means that you can quickly append and get slices of this type.
///
/// Note: Booleans do not implement this trait because D-Bus booleans are 4 bytes and Rust booleans are 1 byte.
pub unsafe trait FixedArray: Arg + 'static + Clone + Copy {}

/// Types that can be used as keys in a dict type implement this trait.
pub trait DictKey: Arg {}



/// Simple lift over reference to value - this makes some iterators more ergonomic to use
impl<'a, T: Arg> Arg for &'a T {
    const ARG_TYPE: ArgType = T::ARG_TYPE;
    fn signature() -> Signature<'static> { T::signature() }
}
impl<'a, T: Append> Append for &'a T {
    fn append_by_ref(&self, i: &mut IterAppend) { (&**self).append_by_ref(i) }
}
impl<'a, T: DictKey> DictKey for &'a T {}

impl<'a, T: RefArg + ?Sized> RefArg for &'a T {
    #[inline]
    fn arg_type(&self) -> ArgType { (&**self).arg_type() }
    #[inline]
    fn signature(&self) -> Signature<'static> { (&**self).signature() }
    #[inline]
    fn append(&self, i: &mut IterAppend) { (&**self).append(i) }
    #[inline]
    fn as_any(&self) -> &dyn any::Any where T: 'static { (&**self).as_any() }
    #[inline]
    fn as_any_mut(&mut self) -> &mut dyn any::Any where T: 'static { unreachable!() }
    #[inline]
    fn as_i64(&self) -> Option<i64> { (&**self).as_i64() }
    #[inline]
    fn as_u64(&self) -> Option<u64> { (&**self).as_u64() }
    #[inline]
    fn as_f64(&self) -> Option<f64> { (&**self).as_f64() }
    #[inline]
    fn as_str(&self) -> Option<&str> { (&**self).as_str() }
    #[inline]
    fn as_iter<'b>(&'b self) -> Option<Box<dyn Iterator<Item=&'b dyn RefArg> + 'b>> { (&**self).as_iter() }
    #[inline]
    fn as_static_inner(&self, index: usize) -> Option<&(dyn RefArg + 'static)> where Self: 'static { (&**self).as_static_inner(index) }    
    #[inline]
    fn box_clone(&self) -> Box<dyn RefArg + 'static> { (&**self).box_clone() }
}



macro_rules! deref_impl {
    ($t: ident, $ss: ident, $make_mut: expr) => {

impl<T: RefArg + ?Sized> RefArg for $t<T> {
    #[inline]
    fn arg_type(&self) -> ArgType { (&**self).arg_type() }
    #[inline]
    fn signature(&self) -> Signature<'static> { (&**self).signature() }
    #[inline]
    fn append(&self, i: &mut IterAppend) { (&**self).append(i) }
    #[inline]
    fn as_any(&self) -> &dyn any::Any where T: 'static { (&**self).as_any() }
    #[inline]
    fn as_any_mut(&mut $ss) -> &mut dyn any::Any where T: 'static { $make_mut.as_any_mut() }
    #[inline]
    fn as_i64(&self) -> Option<i64> { (&**self).as_i64() }
    #[inline]
    fn as_u64(&self) -> Option<u64> { (&**self).as_u64() }
    #[inline]
    fn as_f64(&self) -> Option<f64> { (&**self).as_f64() }
    #[inline]
    fn as_str(&self) -> Option<&str> { (&**self).as_str() }
    #[inline]
    fn as_iter<'a>(&'a self) -> Option<Box<dyn Iterator<Item=&'a dyn RefArg> + 'a>> { (&**self).as_iter() }
    #[inline]
    fn as_static_inner(&self, index: usize) -> Option<&(dyn RefArg + 'static)> where Self: 'static { (&**self).as_static_inner(index) }
    #[inline]
    fn box_clone(&self) -> Box<dyn RefArg + 'static> { (&**self).box_clone() }
}
impl<T: DictKey> DictKey for $t<T> {}

impl<T: Arg> Arg for $t<T> {
    const ARG_TYPE: ArgType = T::ARG_TYPE;
    fn signature() -> Signature<'static> { T::signature() }
}
impl<'a, T: Get<'a>> Get<'a> for $t<T> {
    fn get(i: &mut Iter<'a>) -> Option<Self> { T::get(i).map($t::new) }
}

    }
}

impl<T: Append> Append for Box<T> {
    fn append_by_ref(&self, i: &mut IterAppend) { (&**self).append_by_ref(i) }
}

deref_impl!(Box, self, &mut **self );
deref_impl!(Rc, self, Rc::get_mut(self).unwrap());
deref_impl!(Arc, self, Arc::get_mut(self).unwrap());

macro_rules! argall_impl {
    ($($n: ident $t: ident $s: ty,)+) => {

impl<$($t: Arg),*> ArgAll for ($($t,)*) {
    type strs = ($(&'static $s,)*);
    fn strs_sig<Q: FnMut(&'static str, Signature<'static>)>(z: Self::strs, mut q: Q) {
        let ( $($n,)*) = z;
        $( q($n, $t::signature()); )*
    }
}

impl<$($t: Append),*> AppendAll for ($($t,)*) {
    fn append(&self, ia: &mut IterAppend) {
        let ( $($n,)*) = self;
        $( ia.append($n); )*
    }
}

impl<$($t: Arg + for<'z> Get<'z>),*> ReadAll for ($($t,)*) {
    fn read(ii: &mut Iter) -> Result<Self, TypeMismatchError> {
        $( let $n = ii.read()?; )*
        Ok(($( $n, )* ))
    }
}


    }
}

impl ArgAll for () {
    type strs = ();
    fn strs_sig<F: FnMut(&'static str, Signature<'static>)>(_: Self::strs, _: F) {}
}

impl AppendAll for () {
    fn append(&self, _: &mut IterAppend) {}
}

impl ReadAll for () {
    fn read(_: &mut Iter) -> Result<Self, TypeMismatchError> {
        Ok(())
    }
}

argall_impl!(a A str,);
argall_impl!(a A str, b B str,);
argall_impl!(a A str, b B str, c C str,);
argall_impl!(a A str, b B str, c C str, d D str,);
argall_impl!(a A str, b B str, c C str, d D str, e E str,);
argall_impl!(a A str, b B str, c C str, d D str, e E str, f F str,);
argall_impl!(a A str, b B str, c C str, d D str, e E str, f F str, g G str,);
argall_impl!(a A str, b B str, c C str, d D str, e E str, f F str, g G str, h H str,);
argall_impl!(a A str, b B str, c C str, d D str, e E str, f F str, g G str, h H str, i I str,);
argall_impl!(a A str, b B str, c C str, d D str, e E str, f F str, g G str, h H str, i I str, j J str,);



#[cfg(test)]
mod test {
    use crate::{channel::{Channel, BusType}, Message, Path, Signature};
    use crate::message::MessageType;
    use crate::arg::{Array, Variant, Dict, Iter, ArgType, TypeMismatchError, RefArg, cast};

    use std::collections::HashMap;

    #[test]
    fn refarg() {
        let c = Channel::get_private(BusType::Session).unwrap();
        let m = Message::new_method_call(c.unique_name().unwrap(), "/mooh", "com.example.hello", "Hello").unwrap();

        let mut vv: Vec<Variant<Box<dyn RefArg>>> = vec!();
        vv.push(Variant(Box::new(5i32)));
        vv.push(Variant(Box::new(String::from("Hello world"))));
        let m = m.append_ref(&vv);

        let (f1, f2) = (false, 7u64);
        let mut v: Vec<&dyn RefArg> = vec!();
        v.push(&f1);
        v.push(&f2);
        let m = m.append_ref(&v);
        let vi32 = vec![7i32, 9i32];
        let vstr: Vec<String> = ["This", "is", "dbus", "rs"].iter().map(|&s| s.into()).collect();
        let m = m.append_ref(&[&vi32 as &dyn RefArg, &vstr as &dyn RefArg]);
        let mut map = HashMap::new();
        map.insert(true, String::from("Yes"));
        map.insert(false, String::from("No"));
        let m = m.append_ref(&[&map as &dyn RefArg, &1.5f64 as &dyn RefArg]);

        c.send(m).unwrap();

        loop {
            if let Some(m) = c.blocking_pop_message(std::time::Duration::from_millis(1000)).unwrap() {
                if m.msg_type() != MessageType::MethodCall { continue; }

                let rv: Vec<Box<dyn RefArg + 'static>> = m.iter_init().collect();
                println!("Receiving {:?}", rv);
                let rv0: &Variant<Box<dyn RefArg>> = cast(&rv[0]).unwrap();
                let rv00: &i32 = cast(&rv0.0).unwrap();
                assert_eq!(rv00, &5i32);
                assert_eq!(Some(&false), rv[2].as_any().downcast_ref::<bool>());
                assert_eq!(Some(&vi32), rv[4].as_any().downcast_ref::<Vec<i32>>());
                assert_eq!(Some(&vstr), rv[5].as_any().downcast_ref::<Vec<String>>());
                let mut diter = rv[6].as_iter().unwrap();
                {
                    let mut mmap: HashMap<bool, String> = HashMap::new();
                    while let Some(k) = diter.next() {
                        let x: String = diter.next().unwrap().as_str().unwrap().into();
                        mmap.insert(*cast::<bool>(&k.box_clone()).unwrap(), x);
                    }
                    assert_eq!(mmap[&true], "Yes");
                }
                let mut iter = rv[6].as_iter().unwrap();
                assert!(iter.next().unwrap().as_i64().is_some());
                assert!(iter.next().unwrap().as_str().is_some());
                assert!(iter.next().unwrap().as_str().is_none());
                assert!(iter.next().unwrap().as_i64().is_none());
                assert!(iter.next().is_none());
                assert!(rv[7].as_f64().unwrap() > 1.0);
                assert!(rv[7].as_f64().unwrap() < 2.0);
                break;
            }
        }
    }

    #[test]
    fn message_types() {
        let c = Channel::get_private(BusType::Session).unwrap();

        let m = Message::new_method_call(c.unique_name().unwrap(), "/hello", "com.example.hello", "Hello").unwrap();
        let m = m.append1(2000u16);
        let m = m.append1(&Array::new(&vec![129u8, 5, 254]));
        let m = m.append2(Variant(&["Hello", "world"][..]), &[32768u16, 16u16, 12u16][..]);
        let m = m.append3(-1i32, &*format!("Hello world"), -3.14f64);
        let m = m.append1((256i16, Variant(18_446_744_073_709_551_615u64)));
        let m = m.append2(Path::new("/a/valid/path").unwrap(), &Signature::new("a{sv}").unwrap());
        let mut z = HashMap::new();
        z.insert(123543u32, true);
        z.insert(0u32, false);
        let m = m.append1(Dict::new(&z));
        let sending = format!("{:?}", m.iter_init());
        println!("Sending {}", sending);
        c.send(m).unwrap();

        loop {
            if let Some(m) = c.blocking_pop_message(std::time::Duration::from_millis(1000)).unwrap() {
                if m.msg_type() != MessageType::MethodCall { continue; }
                use super::Arg;
                let receiving = format!("{:?}", m.iter_init());
                println!("Receiving {}", receiving);
                assert_eq!(sending, receiving);

                assert_eq!(2000u16, m.get1().unwrap());
                assert_eq!(m.get2(), (Some(2000u16), Some(&[129u8, 5, 254][..])));
                assert_eq!(m.read2::<u16, bool>().unwrap_err(),
                    TypeMismatchError { position: 1, found: ArgType::Array, expected: ArgType::Boolean });

                let mut g = m.iter_init();
                let e = g.read::<u32>().unwrap_err();
                assert_eq!(e.pos(), 0);
                assert_eq!(e.expected_arg_type(), ArgType::UInt32);
                assert_eq!(e.found_arg_type(), ArgType::UInt16);

                assert!(g.next() && g.next());
                let v: Variant<Iter> = g.get().unwrap();
                let mut viter = v.0;
                assert_eq!(viter.arg_type(), Array::<&str,()>::ARG_TYPE);
                let a: Array<&str, _> = viter.get().unwrap();
                assert_eq!(a.collect::<Vec<&str>>(), vec!["Hello", "world"]);

                assert!(g.next());
                assert_eq!(g.get::<u16>(), None); // It's an array, not a single u16
                assert!(g.next() && g.next() && g.next() && g.next());

                assert_eq!(g.get(), Some((256i16, Variant(18_446_744_073_709_551_615u64))));
                assert!(g.next());
                assert_eq!(g.get(), Some(Path::new("/a/valid/path").unwrap()));
                assert!(g.next());
                assert_eq!(g.get(), Some(Signature::new("a{sv}").unwrap()));
                assert!(g.next());
                let d: Dict<u32, bool, _> = g.get().unwrap();
                let z2: HashMap<_, _> = d.collect();
                assert_eq!(z, z2);
                break;
            }
        }
    }

    #[test]
    fn cast_vecs() {
        let c = Channel::get_private(BusType::Session).unwrap();

        let m = Message::new_method_call(c.unique_name().unwrap(), "/hello", "com.example.hello", "Hello").unwrap();
        macro_rules! append_array {
            ($m:expr, $t:ty) => {
                $m.append1(Variant(&Array::<&$t, _>::new(&vec![Default::default()])));
            };
        }
        let m = append_array!(m, bool);
        let m = append_array!(m, u8);
        let m = append_array!(m, u16);
        let m = append_array!(m, i16);
        let m = append_array!(m, u32);
        let m = append_array!(m, i32);
        let m = append_array!(m, f64);
        let m = append_array!(m, String);
        c.send(m).unwrap();
        loop {
            if let Some(m) = c.blocking_pop_message(std::time::Duration::from_millis(1000)).unwrap() {
                if m.msg_type() != MessageType::MethodCall {
                    continue;
                }
                let mut i = m.iter_init();
                let mut i2 = m.iter_init();

                macro_rules! check_array {
                    ($t:ty) => {
                        let array: Variant<Box<dyn RefArg>> = i.read().unwrap();
                        assert_eq!(
                            cast::<Vec<$t>>(&(array.0)),
                            Some(&vec![Default::default()]),
                            "a variant containing an array of of {0} should be castable to a Vec<{0}>",
                            std::any::type_name::<$t>()
                        );
                        let refarg = i2.get_refarg().unwrap();
                        println!("refarg {:?}", refarg);
                        let st_inner = refarg.as_static_inner(0).unwrap();
                        println!("st_inner {:?}", st_inner);
                        i2.next();
                        assert_eq!(cast::<Vec<$t>>(st_inner), Some(&vec![Default::default()]));
                    };
                }
                check_array!(bool);
                check_array!(u8);
                check_array!(u16);
                check_array!(i16);
                check_array!(u32);
                check_array!(i32);
                check_array!(f64);
                check_array!(String);
                break;
            }
        }
    }
}