quarb 0.40.1

Query engine for arbors (arboreal graphs - tree-spanned or tree-dominated graphs)
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
110
111
112
113
114
115
116
117
118
119

//! A run's options as the tool sets them, and the graph's state for
//! one run: the declared references' targets, the memo of scopes
//! and links, the children cache. The pipeline keeps its own run
//! state below; entering a run here enters the pipeline's too.
use super::*;
use crate::graph::plan::Budget;
use crate::pipeline::{RunGuard, RunOptions, begin_run};
use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;

/// What a run is given: the pinned instant, the shell gate, the
/// quantifier bound, reproducibility, the declared references'
/// targets, the collation, the sentence bonds, the budget, the plan
/// switch, the head's topic, the environments and the libraries.
#[derive(Clone, Default)]
pub struct Run {
    pub now: Option<(i64, u32)>,
    pub allow_shell: bool,
    pub quantifier_bound: Option<usize>,
    pub reproducible: bool,
    pub ref_targets: HashMap<String, NodeId>,
    pub collation: Option<String>,
    pub bonds: Option<Rc<dyn crate::value::ambient::SentenceBonds>>,
    pub budget: Option<Budget>,
    pub plan: bool,
    pub topic: Option<Value>,
    pub environments: Vec<crate::pipeline::env::Environment>,
    pub libraries: Vec<std::sync::Arc<dyn crate::pipeline::library::CommandLibrary>>,
}

impl Run {
    /// The session's pins and nothing else.
    pub fn ambient() -> Run {
        Run {
            now: crate::value::ambient::invocation_instant(),
            bonds: crate::value::ambient::sentence_bonds(),
            ..Run::default()
        }
    }

    /// The pipeline's share of the options.
    pub fn options(&self) -> RunOptions {
        RunOptions {
            now: self.now,
            allow_shell: self.allow_shell,
            quantifier_bound: self.quantifier_bound,
            reproducible: self.reproducible,
            collation: self.collation.clone(),
            bonds: self.bonds.clone(),
            topic: self.topic.clone(),
            environments: self.environments.clone(),
            libraries: self.libraries.clone(),
        }
    }
}

/// The graph's state of one run.
#[derive(Default)]
pub(crate) struct GraphRun {
    pub(crate) run: Run,
    pub(crate) scopes: HashMap<(usize, String), Rc<ScopeMemo>>,
    pub(crate) last_out: LastLinks,
    pub(crate) last_in: LastLinks,
    pub(crate) children: HashMap<NodeId, Rc<Vec<NodeId>>>,
}

thread_local! {
    static RUNS: RefCell<Vec<GraphRun>> = const { RefCell::new(Vec::new()) };
}

/// A run in progress; dropping it ends the run, the pipeline's with
/// it.
pub(crate) struct GraphGuard {
    _pipeline: RunGuard,
}

impl Drop for GraphGuard {
    fn drop(&mut self) {
        RUNS.with(|r| r.borrow_mut().pop());
    }
}

/// Enter a run: with the options given, else the enclosing run's,
/// else the ambient.
pub(crate) fn enter(run: Option<Run>) -> GraphGuard {
    let run = run.unwrap_or_else(inherited);
    let pipeline = begin_run(Some(run.options()));
    RUNS.with(|r| {
        r.borrow_mut().push(GraphRun {
            run,
            ..GraphRun::default()
        })
    });
    GraphGuard {
        _pipeline: pipeline,
    }
}

/// The run in progress, or the ambient.
pub fn inherited() -> Run {
    RUNS.with(|r| r.borrow().last().map(|g| g.run.clone()))
        .unwrap_or_else(Run::ambient)
}

pub(crate) fn with_graph_run<R>(f: impl FnOnce(&mut GraphRun) -> R) -> R {
    RUNS.with(|r| {
        let mut r = r.borrow_mut();
        match r.last_mut() {
            Some(top) => f(top),
            None => f(&mut GraphRun::default()),
        }
    })
}

/// The node a declared reference's identity resolves to.
pub(crate) fn ref_target(id: &str) -> Option<NodeId> {
    with_graph_run(|g| g.run.ref_targets.get(id).copied())
}