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

use std::collections::HashMap;

use crate::core::config::FluffConfig;
use crate::core::dialects::base::Dialect;
use crate::core::parser::segments::base::{CodeSegment, Segment};
use crate::core::templaters::base::TemplatedFile;

/// Struct for holding the context passed to rule eval function
#[derive(Clone, Debug)]
pub struct RuleContext {
    // These don't change within a file.
    pub dialect: Dialect,
    pub fix: bool,
    pub templated_file: Option<TemplatedFile>,
    pub path: Option<String>,
    pub config: FluffConfig,

    // These change within a file.
    /// segment: The segment in question
    pub segment: Box<dyn Segment>,
    /// parent_stack: A tuple of the path from the root to this segment.
    pub parent_stack: Vec<Box<dyn Segment>>,
    /// raw_stack: All of the raw segments so far in the file
    pub raw_stack: Vec<Box<dyn Segment>>,
    /// memory: Arbitrary storage for the rule
    pub memory: HashMap<String, String>,
    /// segment_idx: The index of this segment in the parent
    pub segment_idx: usize,
}

impl RuleContext {
    pub fn siblings_post(&self) -> Vec<Box<dyn Segment>> {
        if !self.parent_stack.is_empty() {
            self.parent_stack.last().unwrap().get_segments()[self.segment_idx + 1..].to_vec()
        } else {
            Vec::new()
        }
    }
}

impl Default for RuleContext {
    fn default() -> Self {
        Self {
            dialect: Default::default(),
            fix: Default::default(),
            templated_file: Default::default(),
            path: Default::default(),
            config: Default::default(),
            segment: CodeSegment::new("", &<_>::default(), <_>::default()),
            parent_stack: Default::default(),
            raw_stack: Default::default(),
            memory: Default::default(),
            segment_idx: Default::default(),
        }
    }
}