aboutsummaryrefslogtreecommitdiff
path: root/helix-core/src/indent.rs
blob: 5a416147c0a4b6fd9fcd2e785791bc4082815fa5 (plain) (blame)
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
use crate::{
    syntax::Syntax,
    tree_sitter::{Node, Tree},
    Rope, RopeSlice, State,
};

/// To determine indentation of a newly inserted line, figure out the indentation at the last col
/// of the previous line.

pub const TAB_WIDTH: usize = 4;

fn indent_level_for_line(line: RopeSlice) -> usize {
    let mut len = 0;
    for ch in line.chars() {
        match ch {
            '\t' => len += TAB_WIDTH,
            ' ' => len += 1,
            _ => break,
        }
    }

    len / TAB_WIDTH
}

/// Find the highest syntax node at position.
/// This is to identify the column where this node (e.g., an HTML closing tag) ends.
fn get_highest_syntax_node_at_bytepos(syntax: &Syntax, pos: usize) -> Option<Node> {
    let tree = syntax.root_layer.tree.as_ref().unwrap();

    // named_descendant
    let mut node = match tree.root_node().descendant_for_byte_range(pos, pos) {
        Some(node) => node,
        None => return None,
    };

    while let Some(parent) = node.parent() {
        if parent.start_byte() == node.start_byte() {
            node = parent
        } else {
            break;
        }
    }

    Some(node)
}

fn calculate_indentation(node: Option<Node>, newline: bool) -> usize {
    let mut increment = 0;

    // Hardcoded for rust for now
    let indent_scopes = &[
        // indent except first or block?
        "while_expression",
        "for_expression",
        "loop_expression",
        "if_expression",
        "if_let_expression",
        "match_expression",
        "match_arm",
    ];

    // this is for multiline things, such as:
    // self.method()
    //  .chain()
    //  .chain()
    //  where the first line isn't indented
    let indent_except_first_scopes = &[
        "block",
        "arguments",
        "declaration_list",
        "field_declaration_list",
        "enum_variant_list",
        // "function_item",
        // "call_expression",
        // "closure_expression",
        "binary_expression",
        "field_expression",
        //
        "where_predicate", // where_clause instead?
    ];

    let outdent = &["}", "]", ")"];

    let mut node = match node {
        Some(node) => node,
        None => return 0,
    };

    // if we're calculating indentation for a brand new line then the current node will become the
    // parent node. We need to take it's indentation level into account too.
    let node_kind = node.kind();
    if newline
        && (indent_scopes.contains(&node_kind) || indent_except_first_scopes.contains(&node_kind))
    {
        increment += 1;
    }

    while let Some(parent) = node.parent() {
        let not_first_sibling = node.prev_sibling().is_some();
        let not_last_sibling = node.next_sibling().is_some();
        let not_first_or_last_sibling = not_first_sibling && not_last_sibling;

        let parent_kind = parent.kind();

        // println!(
        //     "name: {}\tparent: {}\trange:\t{} {}\tfirst={:?}\tlast={:?}",
        //     node.kind(),
        //     parent.kind(),
        //     node.range().start_point,
        //     node.range().end_point,
        //     node.prev_sibling().is_none(),
        //     node.next_sibling().is_none(),
        // );

        if outdent.contains(&node.kind()) {
            // we outdent by skipping the rules for the current level and jumping up
            node = parent;
            continue;
        }

        let is_scope = indent_scopes.contains(&parent_kind);

        // && not_first_or_last_sibling
        if is_scope && not_first_or_last_sibling {
            // println!("is_scope {}", parent_kind);
            increment += 1
        }

        let is_scope = indent_except_first_scopes.contains(&parent_kind);

        // && not_first_sibling
        if is_scope && not_first_sibling {
            // println!("is_scope_except_first {}", parent_kind);
            increment += 1
        }

        // if last_scope && increment > 0 && ...{ ignore }

        node = parent;
    }

    increment
}

fn find_first_non_whitespace_char(state: &State, line_num: usize) -> Option<usize> {
    let line = state.doc.line(line_num);
    let mut start = state.doc.line_to_char(line_num);

    // find first non-whitespace char
    for ch in line.chars() {
        // TODO: could use memchr with chunks?
        if ch != ' ' && ch != '\t' && ch != '\n' {
            return Some(start);
        }
        start += 1;
    }

    None
}

fn suggested_indent_for_line(syntax: Option<&Syntax>, state: &State, line_num: usize) -> usize {
    let line = state.doc.line(line_num);
    let current = indent_level_for_line(line);

    if let Some(start) = find_first_non_whitespace_char(state, line_num) {
        return suggested_indent_for_pos(syntax, state, start, false);
    };

    // if the line is blank, indent should be zero
    0
}

// TODO: two usecases: if we are triggering this for a new, blank line:
// - it should return 0 when mass indenting stuff
// - it should look up the wrapper node and count it too when we press o/O
pub fn suggested_indent_for_pos(
    syntax: Option<&Syntax>,
    state: &State,
    pos: usize,
    new_line: bool,
) -> usize {
    if let Some(syntax) = syntax {
        let byte_start = state.doc.char_to_byte(pos);
        let node = get_highest_syntax_node_at_bytepos(syntax, byte_start);

        // TODO: special case for comments
        // TODO: if preserve_leading_whitespace
        calculate_indentation(node, new_line)
    } else {
        // TODO: heuristics for non-tree sitter grammars
        0
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_indent_level() {
        let line = Rope::from("        fn new"); // 8 spaces
        assert_eq!(indent_level_for_line(line.slice(..)), 2);
        let line = Rope::from("\t\t\tfn new"); // 3 tabs
        assert_eq!(indent_level_for_line(line.slice(..)), 3);
        // mixed indentation
        let line = Rope::from("\t    \tfn new"); // 1 tab, 4 spaces, tab
        assert_eq!(indent_level_for_line(line.slice(..)), 3);
    }

    #[test]
    fn test_suggested_indent_for_line() {
        let doc = Rope::from(
            "
mod test {
    fn hello_world() {
        1 + 1;

        let does_indentation_work = 1;

        let test_function = function_with_param(this_param,
            that_param
        );

        let test_function = function_with_param(
            this_param,
            that_param
        );

        let test_function = function_with_proper_indent(param1,
            param2,
        );

        let selection = Selection::new(
            changes
                .clone()
                .map(|(start, end, text): (usize, usize, Option<Tendril>)| {
                    let len = text.map(|text| text.len()).unwrap() - 1; // minus newline
                    let pos = start + len;
                    Range::new(pos, pos)
                })
                .collect(),
            0,
        );

        return;
    }
}

impl<A, D> MyTrait<A, D> for YourType
where
    A: TraitB + TraitC,
    D: TraitE + TraitF,
{

}
#[test]
//

",
        );

        let state = State::new(doc);
        // TODO: set_language
        let language_config = crate::syntax::LOADER
            .language_config_for_scope("source.rust")
            .unwrap();
        let highlight_config = language_config.highlight_config(&[]).unwrap().unwrap();
        let syntax = Syntax::new(&state.doc, highlight_config.clone());

        // {
        //   {
        //     1 + 1
        //   }
        // }
        // assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 1), 0); // {
        // assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 2), 1); // {
        // assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 3), 2); //
        // assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 4), 1); // }
        // assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 5), 0); // }

        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 1), 0); // mod
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 2), 1); // fn
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 3), 2); // 1 + 1
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 4), 0); //
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 5), 2); // does_indentation_work
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 7), 2); // let test_function
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 8), 3); // that_param
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 9), 2); // );
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 10), 0); //
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 11), 2); // let test_function
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 12), 3); // this_param
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 13), 3); // that_param
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 14), 2); // );
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 15), 0); //
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 16), 2); // let test_function
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 17), 3); // param2
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 18), 2); // );
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 20), 2); // let selection
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 21), 3); // changes
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 22), 4); // clone()
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 23), 4); // map()
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 24), 5); // let len
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 25), 5); // let pos
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 26), 5); // Range

        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 27), 4); // })
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 28), 4); // .collect(),
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 29), 3); // 0,
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 30), 2); // })
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 31), 0); //
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 32), 2); // return;
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 33), 1); // }
        assert_eq!(suggested_indent_for_line(Some(&syntax), &state, 34), 0); // }
    }
}