cxx-gen 0.7.193

C++ code generator for integrating `cxx` crate into higher level tools.
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

use crate::syntax::set::{OrderedSet, UnorderedSet};
use crate::syntax::{FnKind, Receiver, Signature, Type};
use proc_macro2::Ident;
use syn::Lifetime;

impl Signature {
    pub fn receiver(&self) -> Option<&Receiver> {
        match &self.kind {
            FnKind::Method(receiver) => Some(receiver),
            FnKind::Assoc(_) | FnKind::Free => None,
        }
    }

    pub fn receiver_mut(&mut self) -> Option<&mut Receiver> {
        match &mut self.kind {
            FnKind::Method(receiver) => Some(receiver),
            FnKind::Assoc(_) | FnKind::Free => None,
        }
    }

    pub fn self_type(&self) -> Option<&Ident> {
        match &self.kind {
            FnKind::Method(receiver) => Some(&receiver.ty.rust),
            FnKind::Assoc(self_type) => Some(self_type),
            FnKind::Free => None,
        }
    }

    #[cfg_attr(not(proc_macro), allow(dead_code))]
    pub fn undeclared_lifetimes<'a>(&'a self) -> OrderedSet<&'a Lifetime> {
        let mut declared_lifetimes = UnorderedSet::new();
        for param in self.generics.lifetimes() {
            declared_lifetimes.insert(&param.lifetime);
        }

        let mut undeclared_lifetimes = OrderedSet::new();
        let mut collect_lifetime = |lifetime: &'a Lifetime| {
            if lifetime.ident != "_"
                && lifetime.ident != "static"
                && !declared_lifetimes.contains(lifetime)
            {
                undeclared_lifetimes.insert(lifetime);
            }
        };

        match &self.kind {
            FnKind::Method(receiver) => {
                if let Some(lifetime) = &receiver.lifetime {
                    collect_lifetime(lifetime);
                }
                for lifetime in &receiver.ty.generics.lifetimes {
                    collect_lifetime(lifetime);
                }
            }
            FnKind::Assoc(self_type) => {
                // If support is added for explicit lifetimes in the Self type
                // of static member functions, that needs to be handled here.
                let _: &Ident = self_type;
            }
            FnKind::Free => {}
        }

        fn collect_type<'a>(collect_lifetime: &mut impl FnMut(&'a Lifetime), ty: &'a Type) {
            match ty {
                Type::Ident(named_type) => {
                    for lifetime in &named_type.generics.lifetimes {
                        collect_lifetime(lifetime);
                    }
                }
                Type::RustBox(ty1)
                | Type::RustVec(ty1)
                | Type::UniquePtr(ty1)
                | Type::SharedPtr(ty1)
                | Type::WeakPtr(ty1)
                | Type::CxxVector(ty1) => collect_type(collect_lifetime, &ty1.inner),
                Type::Ref(ty) | Type::Str(ty) => {
                    if let Some(lifetime) = &ty.lifetime {
                        collect_lifetime(lifetime);
                    }
                    collect_type(collect_lifetime, &ty.inner);
                }
                Type::Ptr(ty) => collect_type(collect_lifetime, &ty.inner),
                Type::Fn(signature) => {
                    for lifetime in signature.undeclared_lifetimes() {
                        collect_lifetime(lifetime);
                    }
                }
                Type::Void(_) => {}
                Type::SliceRef(ty) => {
                    if let Some(lifetime) = &ty.lifetime {
                        collect_lifetime(lifetime);
                    }
                    collect_type(collect_lifetime, &ty.inner);
                }
                Type::Array(ty) => collect_type(collect_lifetime, &ty.inner),
            }
        }

        for arg in &self.args {
            collect_type(&mut collect_lifetime, &arg.ty);
        }

        if let Some(ret) = &self.ret {
            collect_type(&mut collect_lifetime, ret);
        }

        undeclared_lifetimes
    }
}