git.iko.soy/helix
on master help sign in
Add object.movement for tree-sitter navigation
commitab2a0f325b906574698933824b381ed65c7482a3 authorGokul Soumya <gokulps15@gmail.com> dateFri 11 Feb 2022, 09:01 (5 years ago) parent989407f
5 files changed+43−5
compare with master
unifiedsplit
book/src/guides/textobject.md+15 book/src/usage.md+1−1 helix-core/src/movement.rs+7−3 helix-core/src/syntax.rs+15−1 helix-core/src/textobject.rs+5
book/src/guides/textobject.md+15
@@ -24,7 +24,22 @@ The following [captures][tree-sitter-captures] are recognized:
2424
2525[Example query files][textobject-examples] can be found in the helix GitHub repository.
2626
27+## Queries for Textobject Based Navigation
28+
29+[Tree-sitter based navigation][textobjects-nav] is done using captures in the
30+following order:
31+
32+- `object.movement`
33+- `object.around`
34+- `object.inside`
35+
36+For example if a `function.around` capture has been already defined for a language
37+in it's `textobjects.scm` file, function navigation should also work automatically.
38+`function.movement` should be defined only if the node captured by `function.around`
39+doesn't make sense in a navigation context.
40+
2741[textobjects]: ../usage.md#textobjects
42+[textobjects-nav]: ../usage.md#tree-sitter-textobject-based-navigation
2843[tree-sitter-queries]: https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax
2944[tree-sitter-captures]: https://tree-sitter.github.io/tree-sitter/using-parsers#capturing-nodes
3045[textobject-examples]: https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+filename%3Atextobjects.scm&type=Code&ref=advsearch&l=&l=
book/src/usage.md+1−1
@@ -75,7 +75,7 @@ document and a special tree-sitter query file to work properly. [Only
7575some grammars][lang-support] currently have the query file implemented.
7676Contributions are welcome!
7777
78−## Tree-sitter Based Navigation
78+## Tree-sitter Textobject Based Navigation
7979
8080Navigating between functions, classes, parameters, etc is made
8181possible by leveraging tree-sitter and textobjects queries. For
helix-core/src/movement.rs+7−3
@@ -321,10 +321,14 @@ pub fn goto_treesitter_object(
321321 let get_range = move || -> Option<Range> {
322322 let byte_pos = slice.char_to_byte(range.cursor(slice));
323323
324− let capture_name = format!("{}.{}", object_name, TextObject::Around);
324+ let cap_name = |t: TextObject| format!("{}.{}", object_name, t);
325325 let mut cursor = QueryCursor::new();
326− let nodes = lang_config.textobject_query()?.capture_nodes(
327− &capture_name,
326+ let nodes = lang_config.textobject_query()?.capture_nodes_any(
327+ &[
328+ &cap_name(TextObject::Movement),
329+ &cap_name(TextObject::Around),
330+ &cap_name(TextObject::Inside),
331+ ],
328332 slice_tree,
329333 slice,
330334 &mut cursor,
helix-core/src/syntax.rs+15−1
@@ -188,7 +188,21 @@ impl TextObjectQuery {
188188 slice: RopeSlice<'a>,
189189 cursor: &'a mut QueryCursor,
190190 ) -> Option<impl Iterator<Item = Node<'a>>> {
191− let capture_idx = self.query.capture_index_for_name(capture_name)?;
191+ self.capture_nodes_any(&[capture_name], node, slice, cursor)
192+ }
193+
194+ /// Find the first capture that exists out of all given `capture_names`
195+ /// and return sub nodes that match this capture.
196+ pub fn capture_nodes_any<'a>(
197+ &'a self,
198+ capture_names: &[&str],
199+ node: Node<'a>,
200+ slice: RopeSlice<'a>,
201+ cursor: &'a mut QueryCursor,
202+ ) -> Option<impl Iterator<Item = Node<'a>>> {
203+ let capture_idx = capture_names
204+ .iter()
205+ .find_map(|cap| self.query.capture_index_for_name(cap))?;
192206 let captures = cursor.captures(&self.query, node, RopeProvider(slice));
193207
194208 captures
helix-core/src/textobject.rs+5
@@ -53,6 +53,8 @@ fn find_word_boundary(slice: RopeSlice, mut pos: usize, direction: Direction, lo
5353pub enum TextObject {
5454 Around,
5555 Inside,
56+ /// Used for moving between objects.
57+ Movement,
5658}
5759
5860impl Display for TextObject {
@@ -60,6 +62,7 @@ impl Display for TextObject {
6062 f.write_str(match self {
6163 Self::Around => "around",
6264 Self::Inside => "inside",
65+ Self::Movement => "movement",
6366 })
6467 }
6568}
@@ -104,6 +107,7 @@ pub fn textobject_word(
104107 Range::new(word_start - whitespace_count_left, word_end)
105108 }
106109 }
110+ TextObject::Movement => unreachable!(),
107111 }
108112}
109113
@@ -118,6 +122,7 @@ pub fn textobject_surround(
118122 .map(|(anchor, head)| match textobject {
119123 TextObject::Inside => Range::new(next_grapheme_boundary(slice, anchor), head),
120124 TextObject::Around => Range::new(anchor, next_grapheme_boundary(slice, head)),
125+ TextObject::Movement => unreachable!(),
121126 })
122127 .unwrap_or(range)
123128}