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

use std::str::FromStr;

use super::{c_type::is_mut_ptr, record_type::RecordType};
use crate::{config::gobjects::GObject, env, library};

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum RefMode {
    None,
    ByRef,
    ByRefMut,
    ByRefImmut, // immutable reference with mutable pointer in sys
    ByRefConst, // instance parameters in trait function with const pointer in sys
    ByRefFake,
}

impl FromStr for RefMode {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "none" => Ok(Self::None),
            "ref" => Ok(Self::ByRef),
            "ref-mut" => Ok(Self::ByRefMut),
            "ref-immut" => Ok(Self::ByRefImmut),
            "ref-fake" => Ok(Self::ByRefFake),
            name => Err(format!("Unknown reference mode '{name}'")),
        }
    }
}

impl RefMode {
    #[inline]
    pub fn of(
        env: &env::Env,
        tid: library::TypeId,
        direction: library::ParameterDirection,
    ) -> Self {
        use crate::library::Type::*;

        let library = &env.library;

        if let Some(&GObject {
            ref_mode: Some(ref_mode),
            ..
        }) = env.config.objects.get(&tid.full_name(library))
        {
            if direction == library::ParameterDirection::In {
                return ref_mode;
            } else {
                return Self::None;
            }
        }

        match library.type_(tid) {
            Basic(library::Basic::Utf8 | library::Basic::Filename | library::Basic::OsString)
            | Class(..)
            | Interface(..)
            | List(..)
            | SList(..)
            | PtrArray(..)
            | CArray(..) => {
                if direction == library::ParameterDirection::In {
                    Self::ByRef
                } else {
                    Self::None
                }
            }
            Record(record) => {
                if direction == library::ParameterDirection::In {
                    if let RecordType::Refcounted = RecordType::of(record) {
                        Self::ByRef
                    } else {
                        Self::ByRefMut
                    }
                } else {
                    Self::None
                }
            }
            Union(..) => {
                if direction == library::ParameterDirection::In {
                    Self::ByRefMut
                } else {
                    Self::None
                }
            }
            Alias(alias) => Self::of(env, alias.typ, direction),
            _ => Self::None,
        }
    }

    pub fn without_unneeded_mut(
        env: &env::Env,
        par: &library::Parameter,
        immutable: bool,
        self_in_trait: bool,
    ) -> Self {
        let ref_mode = Self::of(env, par.typ, par.direction);
        match ref_mode {
            Self::ByRefMut if !is_mut_ptr(&par.c_type) => Self::ByRef,
            Self::ByRefMut if immutable => Self::ByRefImmut,
            Self::ByRef if self_in_trait && !is_mut_ptr(&par.c_type) => Self::ByRefConst,
            ref_mode => ref_mode,
        }
    }

    pub fn is_ref(self) -> bool {
        match self {
            Self::None => false,
            Self::ByRef => true,
            Self::ByRefMut => true,
            Self::ByRefImmut => true,
            Self::ByRefConst => true,
            Self::ByRefFake => true,
        }
    }
}