bevy-convars 0.2.1

An implementation of convars (config or console variables) for configuring your Bevy application.
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

use toml_edit::{ImDocument, Item, Table};

use crate::{CVarFlags, CVarManagement, CVarTreeNode, reflect::ReflectCVar};

pub(crate) type UnparsedCVar<'a> = (&'a str, Item);

pub(crate) struct CVarDocScanner<S: AsRef<str>> {
    document: ImDocument<S>,
    source: String,
}

/// A toml document and it's associated source data
#[derive(Clone)]
pub struct DocumentContext<S: AsRef<str>> {
    document: ImDocument<S>,
    source: String,
}

impl Default for DocumentContext<String> {
    fn default() -> Self {
        Self {
            document: ImDocument::parse(String::new()).unwrap(),
            source: Default::default(),
        }
    }
}

impl<S: AsRef<str>> DocumentContext<S> {
    /// Creates a new DocumentContext.
    pub fn new(document: ImDocument<S>, source: String) -> Self {
        Self { document, source }
    }

    /// Returns the source of this document.
    pub fn source(&self) -> &str {
        &self.source
    }
}

impl<S: AsRef<str>> CVarDocScanner<S> {
    pub fn new(document: DocumentContext<S>) -> Self {
        Self {
            document: document.document,
            source: document.source,
        }
    }

    /// Recursively traverse a TOML document for CVars.
    fn traverse(
        &self,
        item: &Table,
        management: &CVarManagement,
        tree: &CVarTreeNode,
        outp: &mut Vec<UnparsedCVar<'_>>,
    ) {
        for (key, node) in tree.children().unwrap() {
            // Check if the node key exists within the document we're traversing, and if so get the value.
            println!("{key}");
            if let Some((_, value)) = item.get_key_value(key) {
                if node.is_leaf() {
                    let CVarTreeNode::Leaf { name, reg } = node else {
                        unreachable!()
                    };

                    let meta = management.resources[reg].data::<ReflectCVar>().unwrap();

                    if meta.flags().contains(CVarFlags::SAVED) {
                        outp.push((*name, value.clone()));
                    } else {
                        bevy_log::warn!(
                            "Found cvar {name} in {}, but that CVar cannot be saved (and as such cannot be loaded.)",
                            self.source
                        );
                    }
                } else if let Some(item) = value.as_table() {
                    self.traverse(item, management, node, outp);
                } else {
                    bevy_log::warn!(
                        "When parsing {}, found a cvar-like key {key} that was expected to be a table. Was of type {}",
                        self.source,
                        value.type_name()
                    );
                }
            }
        }
    }

    pub fn find_cvars(&self, management: &CVarManagement) -> Vec<UnparsedCVar<'_>> {
        let mut outp = vec![];

        self.traverse(
            self.document.as_table(),
            management,
            &management.tree,
            &mut outp,
        );

        outp
    }
}