sqlformat 0.5.0

Formats whitespace in a SQL string to make it easier to read
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

use crate::tokenizer::{Token, TokenKind};

pub(crate) struct BlockInfo {
    length: usize,
    has_forbidden_tokens: bool,
    has_reseved_tokens: bool,
    top_level_token_span: usize,
}

pub(crate) struct InlineBlock {
    level: usize,
    inline_max_length: usize,
    reserved_limit: usize,
    reserved_top_limit: usize,
    info: Vec<BlockInfo>,
}

impl Default for InlineBlock {
    fn default() -> Self {
        InlineBlock {
            info: Vec::new(),
            level: 0,
            inline_max_length: 50,
            reserved_limit: 0,
            reserved_top_limit: 0,
        }
    }
}

impl InlineBlock {
    pub fn new(inline_max_length: usize, reserved_limit: usize, reserved_top_limit: usize) -> Self {
        InlineBlock {
            inline_max_length,
            reserved_limit,
            reserved_top_limit,
            ..Default::default()
        }
    }

    fn is_inline_block(&self, info: &BlockInfo) -> bool {
        !info.has_forbidden_tokens
            && info.length <= self.inline_max_length
            && info.top_level_token_span <= self.reserved_top_limit
            && (!info.has_reseved_tokens || info.length <= self.reserved_limit)
    }

    pub fn begin_if_possible(&mut self, tokens: &[Token<'_>], index: usize) -> bool {
        let info = self.build_info(tokens, index);
        if self.level == 0 && self.is_inline_block(&info) {
            self.level = 1;
        } else if self.level > 0 {
            self.level += 1;
        } else {
            self.level = 0;
        }
        if self.level > 0 {
            self.info.push(info);
            true
        } else {
            false
        }
    }

    pub fn end(&mut self) {
        self.info.pop();
        self.level -= 1;
    }

    pub fn is_active(&self) -> bool {
        self.level > 0
    }

    /// Get the current inline block length
    pub fn cur_len(&self) -> usize {
        self.info.last().map_or(0, |info| info.length)
    }

    fn build_info(&self, tokens: &[Token<'_>], index: usize) -> BlockInfo {
        let mut length = 0;
        let mut level = 0;
        let mut top_level_token_span = 0;
        let mut start_top_level = -1;
        let mut start_span = 0;
        let mut has_forbidden_tokens = false;
        let mut has_reseved_tokens = false;

        for token in &tokens[index..] {
            length += token.value.len();
            match token.kind {
                TokenKind::ReservedTopLevel | TokenKind::ReservedTopLevelNoIndent => {
                    if start_top_level != -1 {
                        if start_top_level == level {
                            top_level_token_span = top_level_token_span.max(length - start_span);
                            start_top_level = -1;
                        }
                    } else {
                        start_top_level = level;
                        start_span = length;
                    }
                }
                TokenKind::ReservedNewline => {
                    has_reseved_tokens = true;
                }
                TokenKind::OpenParen => {
                    level += 1;
                }
                TokenKind::CloseParen => {
                    level -= 1;
                    if level == 0 {
                        break;
                    }
                }
                _ => {}
            }

            if self.is_forbidden_token(token) {
                has_forbidden_tokens = true;
            }
        }

        // broken syntax let's try our best
        BlockInfo {
            length,
            has_forbidden_tokens,
            has_reseved_tokens,
            top_level_token_span,
        }
    }

    fn is_forbidden_token(&self, token: &Token<'_>) -> bool {
        token.kind == TokenKind::LineComment
            || token.kind == TokenKind::BlockComment
            || token.value == ";"
    }
}