godot-core 0.5.1

Internal crate used by godot-rust
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

/*
 * Copyright (c) godot-rust; Bromeon and contributors.
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

use godot_ffi as sys;
use sys::interface_fn;

use crate::builtin::StringName;
use crate::meta::ClassId;

/// A constant named `name` with the value `value`.
pub struct IntegerConstant {
    name: StringName,
    value: i64,
}

impl IntegerConstant {
    pub fn new<T>(name: &str, value: T) -> Self
    where
        T: TryInto<i64> + Copy + std::fmt::Debug,
    {
        Self {
            name: StringName::from(name),
            value: value.try_into().ok().unwrap_or_else(|| {
                panic!("exported constant `{value:?}` must be representable as `i64`")
            }),
        }
    }

    fn register(&self, class_name: ClassId, enum_name: &StringName, is_bitfield: bool) {
        unsafe {
            interface_fn!(classdb_register_extension_class_integer_constant)(
                sys::get_library(),
                class_name.string_sys(),
                enum_name.string_sys(),
                self.name.string_sys(),
                self.value,
                sys::conv::bool_to_sys(is_bitfield),
            );
        }
    }
}

/// Whether the constant should be interpreted as a single integer, an enum with several variants, or a
/// bitfield with several flags.
pub enum ConstantKind {
    Integer(IntegerConstant),
    Enum {
        name: StringName,
        enumerators: Vec<IntegerConstant>,
    },
    Bitfield {
        name: StringName,
        flags: Vec<IntegerConstant>,
    },
}

impl ConstantKind {
    fn register(&self, class_name: ClassId) {
        match self {
            ConstantKind::Integer(integer) => {
                integer.register(class_name, &StringName::default(), false)
            }
            ConstantKind::Enum { name, enumerators } => {
                for enumerator in enumerators.iter() {
                    enumerator.register(class_name, name, false)
                }
            }
            ConstantKind::Bitfield { name, flags } => {
                for flag in flags.iter() {
                    flag.register(class_name, name, true)
                }
            }
        }
    }
}

/// All the info needed to export a constant to Godot.
pub struct ExportConstant {
    class_name: ClassId,
    kind: ConstantKind,
}

impl ExportConstant {
    pub fn new(class_name: ClassId, kind: ConstantKind) -> Self {
        Self { class_name, kind }
    }

    pub fn register(&self) {
        self.kind.register(self.class_name)
    }
}