MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

[groovy] fix label formatting (IDEA-194906)

Browse Source 
- split #generateSubBlockForCodeBlocks into two methods: #generateCodeSubBlocks and #generateSubBlocks;
- use former method for code block only, flatten children independently of label setting;
- use latter method for members (don't need to flatten) and children of GrLabelBlock (already flattened);
- given correct blocks from above changes, update GroovyIndentProcessor to use respective settings (i.e. go down to
#visitLabeledStatement instead of this werid logic in #getChildIndent).
This commit is contained in:
Daniil Ovchinnikov
2018-07-09 18:47:55 +03:00
parent 0d827af7ea
commit ffe0db4c64
9 changed files with 202 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/groovy/src/org/jetbrains/plugins/groovy/formatter/blocks/ClosureBodyBlock.java
+2 -16
View File
@@ -1,18 +1,4 @@
/*
* Copyright 2000-2013 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package org.jetbrains.plugins.groovy.formatter.blocks;
import com.intellij.formatting.Block;
@@ -52,7 +38,7 @@ public class ClosureBodyBlock extends GroovyBlock {
GroovyBlockGenerator generator = new GroovyBlockGenerator(this);
List<ASTNode> children = GroovyBlockGenerator.getClosureBodyVisibleChildren(myNode.getTreeParent());
mySubBlocks = generator.generateSubBlockForCodeBlocks(false, children, myContext.getGroovySettings().INDENT_LABEL_BLOCKS);
mySubBlocks = generator.generateCodeSubBlocks(children);
//at least -> exists
assert !mySubBlocks.isEmpty();
plugins/groovy/src/org/jetbrains/plugins/groovy/formatter/blocks/GrLabelBlock.java
+2 -17
View File
@@ -1,18 +1,4 @@
/*
* Copyright 2000-2014 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package org.jetbrains.plugins.groovy.formatter.blocks;
import com.intellij.formatting.Block;
@@ -34,14 +20,13 @@ public class GrLabelBlock extends GroovyBlockWithRange {
public GrLabelBlock(@NotNull ASTNode node,
List<ASTNode> subStatements,
boolean classLevel,
@NotNull Indent indent,
@Nullable Wrap wrap,
@NotNull FormattingContext context) {
super(node, indent, createTextRange(subStatements), wrap, context);
final GroovyBlockGenerator generator = new GroovyBlockGenerator(this);
myBlocks = generator.generateSubBlockForCodeBlocks(classLevel, subStatements, false);
myBlocks = generator.generateSubBlocks(subStatements, false);
}
private static TextRange createTextRange(List<ASTNode> subStatements) {
plugins/groovy/src/org/jetbrains/plugins/groovy/formatter/blocks/GroovyBlockGenerator.java
+35 -41
View File
@@ -27,7 +27,6 @@ import org.jetbrains.plugins.groovy.formatter.processors.GroovyWrappingProcessor
import org.jetbrains.plugins.groovy.lang.lexer.GroovyTokenTypes;
import org.jetbrains.plugins.groovy.lang.lexer.TokenSets;
import org.jetbrains.plugins.groovy.lang.parser.GroovyElementTypes;
import org.jetbrains.plugins.groovy.lang.parser.GroovyParserDefinition;
import org.jetbrains.plugins.groovy.lang.psi.GrQualifiedReference;
import org.jetbrains.plugins.groovy.lang.psi.GroovyElementVisitor;
import org.jetbrains.plugins.groovy.lang.psi.GroovyFile;
@@ -247,8 +246,11 @@ public class GroovyBlockGenerator {
return blocks;
}
if (blockPsi instanceof GrCodeBlock || blockPsi instanceof GroovyFile || classLevel) {
return generateSubBlockForCodeBlocks(classLevel, visibleChildren(myNode), myContext.getGroovySettings().INDENT_LABEL_BLOCKS);
if (blockPsi instanceof GrCodeBlock || blockPsi instanceof GroovyFile) {
return generateCodeSubBlocks(visibleChildren(myNode));
}
if (classLevel) {
return generateSubBlocks(visibleChildren(myNode), true);
}
if (blockPsi instanceof GrMethod) {
@@ -374,54 +376,46 @@ public class GroovyBlockGenerator {
}
@NotNull
public List<Block> generateSubBlockForCodeBlocks(boolean classLevel, final List<ASTNode> children, boolean indentLabelBlocks) {
List<Block> generateCodeSubBlocks(final List<ASTNode> children) {
final ArrayList<Block> subBlocks = new ArrayList<>();
if (indentLabelBlocks && isCodeBlock()) {
List<ASTNode> flattenChildren = flattenChildren(children);
calculateAlignments(flattenChildren, classLevel);
for (int i = 0; i < flattenChildren.size(); i++) {
ASTNode childNode = flattenChildren.get(i);
if (childNode.getElementType() == GroovyElementTypes.LABELED_STATEMENT) {
int start = i;
do {
i++;
}
while (i < flattenChildren.size() &&
flattenChildren.get(i).getElementType() != GroovyElementTypes.LABELED_STATEMENT &&
flattenChildren.get(i).getElementType() != GroovyTokenTypes.mRCURLY);
subBlocks.add(
new GrLabelBlock(
childNode,
flattenChildren.subList(start + 1, i),
classLevel, getIndent(childNode),
getChildWrap(childNode),
myContext)
);
i--;
}
else {
subBlocks.add(new GroovyBlock(childNode, getIndent(childNode), getChildWrap(childNode), myContext));
List<ASTNode> flattenChildren = flattenChildren(children);
calculateAlignments(flattenChildren, false);
for (int i = 0; i < flattenChildren.size(); i++) {
ASTNode childNode = flattenChildren.get(i);
if (childNode.getElementType() == GroovyElementTypes.LABELED_STATEMENT) {
int start = i;
do {
i++;
}
while (i < flattenChildren.size() &&
flattenChildren.get(i).getElementType() != GroovyElementTypes.LABELED_STATEMENT &&
flattenChildren.get(i).getElementType() != GroovyTokenTypes.mRCURLY);
subBlocks.add(
new GrLabelBlock(
childNode,
flattenChildren.subList(start + 1, i),
getIndent(childNode),
getChildWrap(childNode),
myContext)
);
i--;
}
}
else {
calculateAlignments(children, classLevel);
for (ASTNode childNode : children) {
else {
subBlocks.add(new GroovyBlock(childNode, getIndent(childNode), getChildWrap(childNode), myContext));
}
}
return subBlocks;
}
private boolean isCodeBlock() {
IElementType type = myNode.getElementType();
return type == GroovyElementTypes.OPEN_BLOCK ||
type == GroovyElementTypes.CLOSABLE_BLOCK ||
type == GroovyElementTypes.CONSTRUCTOR_BODY ||
type == GroovyParserDefinition.GROOVY_FILE;
List<Block> generateSubBlocks(List<ASTNode> children, boolean classLevel) {
final List<Block> subBlocks = new ArrayList<>();
calculateAlignments(children, classLevel);
for (ASTNode childNode : children) {
subBlocks.add(new GroovyBlock(childNode, getIndent(childNode), getChildWrap(childNode), myContext));
}
return subBlocks;
}
private static List<ASTNode> flattenChildren(List<ASTNode> children) {
plugins/groovy/src/org/jetbrains/plugins/groovy/formatter/processors/GroovyIndentProcessor.java
-7
View File
@@ -10,7 +10,6 @@ import com.intellij.psi.tree.IElementType;
import com.intellij.psi.tree.TokenSet;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.plugins.groovy.formatter.blocks.ClosureBodyBlock;
import org.jetbrains.plugins.groovy.formatter.blocks.GrLabelBlock;
import org.jetbrains.plugins.groovy.formatter.blocks.GroovyBlock;
import org.jetbrains.plugins.groovy.lang.groovydoc.lexer.GroovyDocTokenTypes;
import org.jetbrains.plugins.groovy.lang.groovydoc.psi.api.GrDocComment;
@@ -87,12 +86,6 @@ public class GroovyIndentProcessor extends GroovyElementVisitor {
return getNormalIndent();
}
}
if (parentBlock instanceof GrLabelBlock) {
ASTNode first = parentBlock.getNode().getFirstChildNode();
return child == first
? getNoneIndent()
: getLabelIndent();
}
if (GSTRING_TOKENS_INNER.contains(myChildType)) {
return getAbsoluteNoneIndent();
plugins/groovy/test/org/jetbrains/plugins/groovy/lang/formatter/FormatterTest.groovy
-59
View File
@@ -4,7 +4,6 @@ package org.jetbrains.plugins.groovy.lang.formatter
import com.intellij.openapi.util.text.StringUtil
import com.intellij.psi.codeStyle.CommonCodeStyleSettings
import org.jetbrains.plugins.groovy.GroovyLanguage
import org.jetbrains.plugins.groovy.codeStyle.GroovyCodeStyleSettings
import org.jetbrains.plugins.groovy.util.TestUtils
@@ -205,12 +204,6 @@ class FormatterTest extends GroovyFormatterTestCase {
doTest()
}
void _testLabelIndentAbsolute() throws Throwable {
groovySettings.indentOptions.LABEL_INDENT_ABSOLUTE = true
groovySettings.indentOptions.LABEL_INDENT_SIZE = 1
doTest()
}
void testClosureParametersAligned() throws Throwable {
groovySettings.ALIGN_MULTILINE_PARAMETERS_IN_CALLS = true
doTest()
@@ -831,41 +824,6 @@ print abc ? cde
: xyz''')
}
void testLabelsInBasicMode() {
groovySettings.indentOptions.INDENT_SIZE = 4
groovySettings.indentOptions.LABEL_INDENT_SIZE = 2
groovyCustomSettings.INDENT_LABEL_BLOCKS = false
checkFormatting('''\
def bar() {
abc:
foo()
bar()
}
''', '''\
def bar() {
abc:
foo()
bar()
}
''')
}
void testLabels() {
groovyCustomSettings.INDENT_LABEL_BLOCKS = false
checkFormatting('''\
def foo() {
abc:foo()
bar()
}
''', '''\
def foo() {
abc: foo()
bar()
}
''')
}
void testGdocAsterisks() {
checkFormatting('''\
/*****
@@ -891,23 +849,6 @@ def foo() {
void testExtraLines() { doTest() }
void testLabelWithDescription() {
GroovyCodeStyleSettings customSettings = myTempSettings.getCustomSettings(GroovyCodeStyleSettings.class)
CommonCodeStyleSettings commonSettings = myTempSettings.getCommonSettings(GroovyLanguage.INSTANCE)
boolean indentLabelBlocks = customSettings.INDENT_LABEL_BLOCKS
int labelIndentSize = commonSettings.indentOptions.LABEL_INDENT_SIZE
try {
customSettings.INDENT_LABEL_BLOCKS = true
commonSettings.indentOptions.LABEL_INDENT_SIZE = 2
doTest()
}
finally {
customSettings.INDENT_LABEL_BLOCKS = indentLabelBlocks
commonSettings.indentOptions.LABEL_INDENT_SIZE = labelIndentSize
}
}
void testNoLineFeedsInGString() { doTest() }
private void doGeeseTest() {
plugins/groovy/test/org/jetbrains/plugins/groovy/lang/formatter/GroovyCodeStyleFormatterTest.groovy
+13 -10
View File
@@ -1,12 +1,9 @@
// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package org.jetbrains.plugins.groovy.lang.formatter
import com.intellij.application.options.CodeStyle
import com.intellij.psi.codeStyle.CodeStyleSettings
import com.intellij.psi.codeStyle.CommonCodeStyleSettings
import org.jetbrains.annotations.NotNull
import org.jetbrains.annotations.Nullable
import org.jetbrains.plugins.groovy.GroovyLanguage
import org.jetbrains.plugins.groovy.codeStyle.GroovyCodeStyleSettings
import org.jetbrains.plugins.groovy.util.TestUtils
@@ -48,13 +45,13 @@ class GroovyCodeStyleFormatterTest extends GroovyFormatterTestCase {
}
private List findSettings(String name) {
CodeStyleSettings settings = CodeStyle.getSettings(project)
try {
return [CommonCodeStyleSettings.getField(name), settings.getCommonSettings(GroovyLanguage.INSTANCE)]
}
catch (NoSuchFieldException ignored) {
return [GroovyCodeStyleSettings.getField(name), settings.getCustomSettings(GroovyCodeStyleSettings)]
}
return findField(CommonCodeStyleSettings, name)?.with { [it, getGroovySettings()] }
?: findField(GroovyCodeStyleSettings, name)?.with { [it, getGroovyCustomSettings()] }
?: findField(CommonCodeStyleSettings.IndentOptions, name)?.with { [it, getGroovySettings().getIndentOptions()] }
}
private static Field findField(Class<?> clazz, String name) {
return clazz.fields.find { it.name == name }
}
@Nullable
@@ -181,4 +178,10 @@ class GroovyCodeStyleFormatterTest extends GroovyFormatterTestCase {
void testArrayInitializerWrapAlwaysAlign() { doTest() }
void testArrayInitializerWrapAlwaysNl() { doTest() }
void testLabelIndentAbsolute() { doTest() }
void testLabelIndentRelative() { doTest() }
void testLabelIndentRelativeReverse() { doTest() }
}
plugins/groovy/testdata/groovy/codeStyle/labelIndentAbsolute.test
Vendored
+50
View File
@@ -0,0 +1,50 @@
<option>LABEL_INDENT_SIZE=1</option>
<option>LABEL_INDENT_ABSOLUTE=true</option>
<option>INDENT_LABEL_BLOCKS=false</option>
class Foo extends spock.lang.Specification {
void 'test table formatting'() {
given: "groovy"
13
expect:
2*2
where:
gradleVersion|_
'long string expression'|_
'3.5.1'|_
'2.14.1'|_
'1.12'|_
}
void foo() {
abcd:
efgh:
1+2
aaa:42
lll:
111
}
}
-----
class Foo extends spock.lang.Specification {
void 'test table formatting'() {
given: "groovy"
13
expect:
2 * 2
where:
gradleVersion | _
'long string expression' | _
'3.5.1' | _
'2.14.1' | _
'1.12' | _
}
void foo() {
abcd:
efgh:
1 + 2
aaa: 42
lll:
111
}
}
plugins/groovy/testdata/groovy/codeStyle/labelIndentRelative.test
Vendored
+50
View File
@@ -0,0 +1,50 @@
<option>LABEL_INDENT_SIZE=1</option>
<option>LABEL_INDENT_ABSOLUTE=false</option>
<option>INDENT_LABEL_BLOCKS=true</option>
class Foo extends spock.lang.Specification {
void 'test table formatting'() {
given: "groovy"
13
expect:
2*2
where:
gradleVersion|_
'long string expression'|_
'3.5.1'|_
'2.14.1'|_
'1.12'|_
}
void foo() {
abcd:
efgh:
1+2
aaa:42
lll:
111
}
}
-----
class Foo extends spock.lang.Specification {
void 'test table formatting'() {
given: "groovy"
13
expect:
2 * 2
where:
gradleVersion | _
'long string expression' | _
'3.5.1' | _
'2.14.1' | _
'1.12' | _
}
void foo() {
abcd:
efgh:
1 + 2
aaa: 42
lll:
111
}
}
plugins/groovy/testdata/groovy/codeStyle/labelIndentRelativeReverse.test
Vendored
+50
View File
@@ -0,0 +1,50 @@
<option>LABEL_INDENT_SIZE=1</option>
<option>LABEL_INDENT_ABSOLUTE=false</option>
<option>INDENT_LABEL_BLOCKS=false</option>
class Foo extends spock.lang.Specification {
void 'test table formatting'() {
given: "groovy"
13
expect:
2*2
where:
gradleVersion|_
'long string expression'|_
'3.5.1'|_
'2.14.1'|_
'1.12'|_
}
void foo() {
abcd:
efgh:
1+2
aaa:42
lll:
111
}
}
-----
class Foo extends spock.lang.Specification {
void 'test table formatting'() {
given: "groovy"
13
expect:
2 * 2
where:
gradleVersion | _
'long string expression' | _
'3.5.1' | _
'2.14.1' | _
'1.12' | _
}
void foo() {
abcd:
efgh:
1 + 2
aaa: 42
lll:
111
}
}