Indentation rework

helix-core/src/syntax.rs

@@ -106,15 +106,92 @@ pub struct IndentationConfiguration {
     pub unit: String,
 }
 
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(untagged)]
+pub enum IndentQueryNode {
+    // A node given just by its kind
+    SimpleNode(String),
+    // A node given by a list of characteristics which must all be fulfilled in order to match
+    ComplexNode {
+        kind: Option<String>,
+        #[serde(default)]
+        #[serde(skip_serializing_if = "Vec::is_empty")]
+        kind_not_in: Vec<String>,
+        #[serde(default)]
+        #[serde(skip_serializing_if = "Vec::is_empty")]
+        parent_kind_in: Vec<String>,
+        #[serde(default)]
+        #[serde(skip_serializing_if = "Vec::is_empty")]
+        field_name_in: Vec<String>,
+    },
+}
+impl IndentQueryNode {
+    pub fn kind(&self) -> Option<&str> {
+        match self {
+            IndentQueryNode::SimpleNode(n) => Some(n),
+            IndentQueryNode::ComplexNode { kind, .. } => kind.as_ref().map(|k| k.as_str()),
+        }
+    }
+}
+impl PartialEq for IndentQueryNode {
+    fn eq(&self, other: &Self) -> bool {
+        self.kind().eq(&other.kind())
+    }
+}
+impl Eq for IndentQueryNode {}
+impl PartialOrd for IndentQueryNode {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        Some(self.cmp(other))
+    }
+}
+impl Ord for IndentQueryNode {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.kind().cmp(&other.kind())
+    }
+}
+
+#[derive(Default, Debug, Serialize)]
+pub struct IndentQueryScopes {
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub all: Vec<IndentQueryNode>,
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub tail: Vec<IndentQueryNode>,
+}
+
+impl<'de> Deserialize<'de> for IndentQueryScopes {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: serde::Deserializer<'de>,
+    {
+        #[derive(Deserialize)]
+        struct Derived {
+            #[serde(default)]
+            pub all: Vec<IndentQueryNode>,
+            #[serde(default)]
+            pub tail: Vec<IndentQueryNode>,
+        }
+        let derived = Derived::deserialize(deserializer)?;
+        let mut result = IndentQueryScopes {
+            all: derived.all,
+            tail: derived.tail,
+        };
+        result.all.sort_unstable();
+        result.tail.sort_unstable();
+        Ok(result)
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 pub struct IndentQuery {
+    /// Every node specified here increases the indent level by one (in total at most one per line)
     #[serde(default)]
-    #[serde(skip_serializing_if = "HashSet::is_empty")]
-    pub indent: HashSet<String>,
+    pub indent: IndentQueryScopes,
+    /// Every node specified here decreases the indent level by one (in total at most one per line)
     #[serde(default)]
-    #[serde(skip_serializing_if = "HashSet::is_empty")]
-    pub outdent: HashSet<String>,
+    pub outdent: IndentQueryScopes,
 }
 
 #[derive(Debug)]

helix-term/src/commands.rs

@@ -3805,17 +3805,16 @@ fn open(cx: &mut Context, open: Open) {
             )
         };
 
-        // TODO: share logic with insert_newline for indentation
-        let indent_level = indent::suggested_indent_for_pos(
+        let indent = indent::indent_for_newline(
             doc.language_config(),
             doc.syntax(),
+            &doc.indent_style,
+            doc.tab_width(),
             text,
-            line_end_index,
             new_line.saturating_sub(1),
-            true,
-        )
-        .unwrap_or_else(|| indent::indent_level_for_line(text.line(cursor_line), doc.tab_width()));
-        let indent = doc.indent_unit().repeat(indent_level);
+            line_end_index,
+            cursor_line,
+        );
         let indent_len = indent.len();
         let mut text = String::with_capacity(1 + indent_len);
         text.push_str(doc.line_ending.as_str());
@@ -4550,23 +4549,20 @@ pub mod insert {
             let curr = contents.get_char(pos).unwrap_or(' ');
 
             let current_line = text.char_to_line(pos);
-            let indent_level = indent::suggested_indent_for_pos(
+            let indent = indent::indent_for_newline(
                 doc.language_config(),
                 doc.syntax(),
+                &doc.indent_style,
+                doc.tab_width(),
                 text,
+                current_line,
                 pos,
                 current_line,
-                true,
-            )
-            .unwrap_or_else(|| {
-                indent::indent_level_for_line(text.line(current_line), doc.tab_width())
-            });
-
-            let indent = doc.indent_unit().repeat(indent_level);
+            );
             let mut text = String::new();
             // If we are between pairs (such as brackets), we want to insert an additional line which is indented one level more and place the cursor there
             let new_head_pos = if helix_core::auto_pairs::PAIRS.contains(&(prev, curr)) {
-                let inner_indent = doc.indent_unit().repeat(indent_level + 1);
+                let inner_indent = indent.clone() + doc.indent_style.as_str();
                 text.reserve_exact(2 + indent.len() + inner_indent.len());
                 text.push_str(doc.line_ending.as_str());
                 text.push_str(&inner_indent);

runtime/queries/c/indents.toml

@@ -1,4 +1,10 @@
-indent = [
+[indent]
+all = [
+  # Indent non-grouped bodies of if-, while- and do-while-statements.
+  # TODO Add indent for the for-statement (ideally the body of a for-statement should have a field name in the tree-sitter grammar)
+  { kind_not_in = ["compound_statement"], parent_kind_in = ["if_statement", "while_statement", "do_statement"], field_name_in = ["consequence", "body"] }
+]
+tail = [
   "compound_statement",
   "field_declaration_list",
   "enumerator_list",
@@ -9,7 +15,8 @@ indent = [
   "expression_statement",
 ]
 
-outdent = [
+[outdent]
+all = [
   "case",
   "}",
   "]",

runtime/queries/cmake/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "if_condition",
   "foreach_loop",
   "while_loop",
@@ -7,6 +7,6 @@ indent = [
   "normal_command",
 ]
 
-outdent = [
+outdent.all = [
   ")"
 ]

runtime/queries/cpp/indents.toml

@@ -1,4 +1,10 @@
-indent = [
+[indent]
+all = [
+  # Indent non-grouped bodies of if-, while- and do-while-statements.
+  # TODO Add indent for the for-statement (ideally the body of a for-statement should have a field name in the tree-sitter grammar)
+  { kind_not_in = ["compound_statement"], parent_kind_in = ["if_statement", "while_statement", "do_statement"], field_name_in = ["consequence", "body"] }
+]
+tail = [
   "compound_statement",
   "field_declaration_list",
   "enumerator_list",
@@ -9,7 +15,8 @@ indent = [
   "expression_statement",
 ]
 
-outdent = [
+[outdent]
+all = [
   "case",
   "access_specifier",
   "}",

runtime/queries/dart/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "class_body",
   "function_body",
   "function_expression_body",
@@ -13,7 +13,7 @@ indent = [
   "arguments"
 ]
 
-outdent = [
+outdent.all = [
  "}",
  "]",
  ")"

runtime/queries/fish/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "function_definition",
   "while_statement",
   "for_statement",
@@ -7,6 +7,6 @@ indent = [
   "switch_statement",
 ]
 
-outdent = [
+outdent.all = [
   "end"
 ]

runtime/queries/glsl/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "init_declarator",
   "compound_statement",
   "preproc_arg",
@@ -10,7 +10,7 @@ indent = [
   "compound_literal_expression"
 ]
 
-outdent = [
+outdent.all = [
   "#define",
   "#ifdef",
   "#endif",

runtime/queries/go/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "import_declaration",
   "const_declaration",
   #"var_declaration",
@@ -20,9 +20,11 @@ indent = [
   "argument_list",
   "field_declaration_list",
   "block",
+  "type_switch_statement",
+  "expression_switch_statement"
 ]
 
-outdent = [
+outdent.all = [
  "case",
  "}",
  "]",

runtime/queries/javascript/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
  "array",
  "object",
  "arguments",
@@ -21,7 +21,7 @@ indent = [
  "object_type",
 ]
 
-outdent = [
+outdent.all = [
  "}",
  "]",
  ")"

runtime/queries/json/indents.toml

@@ -1,9 +1,9 @@
-indent = [
+indent.tail = [
   "object",
   "array"
 ]
 
-outdent = [
+outdent.all = [
   "]",
   "}"
 ]

runtime/queries/llvm-mir-yaml/indents.toml

@@ -1,3 +1,3 @@
-indent = [
+indent.tail = [
     "block_mapping_pair",
 ]

runtime/queries/llvm-mir/indents.toml

@@ -1,7 +1,7 @@
-indent = [
+indent.tail = [
   "basic_block",
 ]
 
-outdent = [
+outdent.all = [
   "label",
 ]

runtime/queries/llvm/indents.toml

@@ -1,8 +1,8 @@
-indent = [
+indent.tail = [
  "function_body",
  "instruction",
 ]
 
-outdent = [
+outdent.all = [
  "}",
 ]

runtime/queries/lua/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "function_definition",
   "variable_declaration",
   "local_variable_declaration",

runtime/queries/nix/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
  # "function",
  "bind",
  "assert",
@@ -12,7 +12,7 @@ indent = [
  "parenthesized",
 ]
 
-outdent = [
+outdent.all = [
   "}",
   "]",
 ]

runtime/queries/ocaml/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
     "let_binding",
     "type_binding",
     "structure",
@@ -8,6 +8,6 @@ indent = [
     "match_case",
 ]
 
-outdent = [
+outdent.all = [
     "}",
 ]

runtime/queries/perl/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "function",
   "identifier",
   "method_invocation",
@@ -12,6 +12,6 @@ indent = [
   "word_list_qw"
 ]
 
-outdent = [
+outdent.all = [
  "}"
 ]

runtime/queries/php/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "array_creation_expression",
   "arguments",
   "formal_parameters",

runtime/queries/protobuf/indents.toml

@@ -1,4 +1,4 @@
-indent = [
+indent.tail = [
   "messageBody",
   "enumBody",
   "oneofBody",
@@ -7,6 +7,6 @@ indent = [
   "msgLit",
 ]
 
-outdent = [
+outdent.all = [
   "}",
 ]