shape-ast 0.1.8

AST types and Pest grammar for the Shape programming language
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

//! Suggestion and related information types for error fixes

use crate::error::SourceLocation;

/// A suggestion for fixing the error
#[derive(Debug, Clone)]
pub struct Suggestion {
    /// Human-readable description
    pub message: String,
    /// Machine-applicable text edit (if applicable)
    pub edit: Option<TextEdit>,
    /// Confidence level
    pub confidence: SuggestionConfidence,
}

impl Suggestion {
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
            edit: None,
            confidence: SuggestionConfidence::Maybe,
        }
    }

    pub fn certain(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
            edit: None,
            confidence: SuggestionConfidence::Certain,
        }
    }

    pub fn likely(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
            edit: None,
            confidence: SuggestionConfidence::Likely,
        }
    }

    pub fn with_edit(mut self, edit: TextEdit) -> Self {
        self.edit = Some(edit);
        self
    }
}

/// Text edit for auto-fix
#[derive(Debug, Clone)]
pub struct TextEdit {
    /// Start position (line, column, both 1-based)
    pub start: (usize, usize),
    /// End position
    pub end: (usize, usize),
    /// Replacement text
    pub new_text: String,
}

impl TextEdit {
    pub fn insert(line: usize, col: usize, text: impl Into<String>) -> Self {
        Self {
            start: (line, col),
            end: (line, col),
            new_text: text.into(),
        }
    }

    pub fn replace(start: (usize, usize), end: (usize, usize), text: impl Into<String>) -> Self {
        Self {
            start,
            end,
            new_text: text.into(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SuggestionConfidence {
    Certain, // Definitely correct fix
    Likely,  // Probably correct
    Maybe,   // One of several possibilities
}

/// Related information (e.g., "unclosed brace opened here")
#[derive(Debug, Clone)]
pub struct RelatedInfo {
    /// Location of related code
    pub location: SourceLocation,
    /// Description
    pub message: String,
}

impl RelatedInfo {
    pub fn new(message: impl Into<String>, location: SourceLocation) -> Self {
        Self {
            location,
            message: message.into(),
        }
    }
}