Skip to content

Commit

Permalink
Rename extend indent captures.
Browse files Browse the repository at this point in the history
Clarify comments in indent code.
  • Loading branch information
Triton171 authored and archseer committed Oct 11, 2022
1 parent dc44348 commit 0813276
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions book/src/guides/indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,16 @@ capture on the same line, the indent level isn't changed at all.
- `@outdent` (default scope `all`):
Decrease the indent level by 1. The same rules as for `@indent` apply.

- `@extend-indented`:
- `@extend`:
Extend the range of this node to the end of the line and to lines that
are indented more than the line that this node starts on. This is useful
for languages like Python, where for the purpose of indentation some nodes
(like functions or classes) should also contain indented lines that follow them.

- `@stop-extend`:
- `@extend.prevent-once`:
Prevents the first extension of an ancestor of this node. For example, in Python
a return expression always ends the block that it is in. Note that this only stops the
extension of the next `@extend-indented` capture. If multiple ancestors are captured,
extension of the next `@extend` capture. If multiple ancestors are captured,
only the extension of the innermost one is prevented. All other ancestors are unaffected
(regardless of whether the innermost ancestor would actually have been extended).

Expand Down
20 changes: 10 additions & 10 deletions helix-core/src/indent.rs
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,8 @@ enum IndentScope {
/// A capture from the indent query which does not define an indent but extends
/// the range of a node. This is used before the indent is calculated.
enum ExtendCapture {
ExtendIndented,
StopExtend,
Extend,
PreventOnce,
}

/// The result of running a tree-sitter indent query. This stores for
Expand Down Expand Up @@ -394,18 +394,18 @@ fn query_indents(
let capture_type = match capture_name {
"indent" => IndentCaptureType::Indent,
"outdent" => IndentCaptureType::Outdent,
"extend-indented" => {
"extend" => {
extend_captures
.entry(capture.node.id())
.or_insert_with(|| Vec::with_capacity(1))
.push(ExtendCapture::ExtendIndented);
.push(ExtendCapture::Extend);
continue;
}
"stop-extend" => {
"extend.prevent-once" => {
extend_captures
.entry(capture.node.id())
.or_insert_with(|| Vec::with_capacity(1))
.push(ExtendCapture::StopExtend);
.push(ExtendCapture::PreventOnce);
continue;
}
_ => {
Expand Down Expand Up @@ -478,10 +478,10 @@ fn extend_nodes<'a>(
if let Some(captures) = extend_captures.get(&deepest_preceding.id()) {
for capture in captures {
match capture {
ExtendCapture::StopExtend => {
ExtendCapture::PreventOnce => {
stop_extend = true;
}
ExtendCapture::ExtendIndented => {
ExtendCapture::Extend => {
node_captured = true;
// We extend the node if
// - the cursor is on the same line as the end of the node OR
Expand Down Expand Up @@ -574,8 +574,8 @@ pub fn treesitter_indent_for_pos(
.descendant_for_byte_range(byte_pos, byte_pos)?;
let (query_result, deepest_preceding) = {
// The query range should intersect with all nodes directly preceding
// the cursor in case one of them is extended.
let mut deepest_preceding = None; // The deepest node preceding the cursor
// the position of the indent query in case one of them is extended.
let mut deepest_preceding = None; // The deepest node preceding the indent query position
let mut tree_cursor = node.walk();
for child in node.children(&mut tree_cursor) {
if child.byte_range().end <= byte_pos {
Expand Down
4 changes: 2 additions & 2 deletions runtime/queries/python/indents.scm
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@

(function_definition)
(class_definition)
] @extend-indented
] @extend

[
(return_statement)
(break_statement)
(continue_statement)
(raise_statement)
(pass_statement)
] @stop-extend
] @extend.prevent-once

[
")"
Expand Down

0 comments on commit 0813276

Please sign in to comment.