diff --git a/java/java-impl/src/com/intellij/psi/formatter/java/wrap/impl/JavaChildWrapArranger.java b/java/java-impl/src/com/intellij/psi/formatter/java/wrap/impl/JavaChildWrapArranger.java new file mode 100644 index 000000000000..e4f1c2fb53cf --- /dev/null +++ b/java/java-impl/src/com/intellij/psi/formatter/java/wrap/impl/JavaChildWrapArranger.java @@ -0,0 +1,227 @@ +/* + * Copyright 2000-2010 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. + */ +package com.intellij.psi.formatter.java.wrap.impl; + +import com.intellij.formatting.Wrap; +import com.intellij.formatting.WrapType; +import com.intellij.lang.ASTNode; +import com.intellij.psi.codeStyle.CodeStyleSettings; +import com.intellij.psi.formatter.java.FormattingAstUtil; +import com.intellij.psi.formatter.java.wrap.JavaWrapManager; +import com.intellij.psi.formatter.java.wrap.ReservedWrapsProvider; +import com.intellij.psi.impl.source.tree.ChildRole; +import com.intellij.psi.impl.source.tree.CompositeElement; +import com.intellij.psi.impl.source.tree.JavaElementType; +import com.intellij.psi.tree.IElementType; +import org.jetbrains.annotations.Nullable; + +/** + * Encapsulates implementation of + * {@link JavaWrapManager#arrangeChildWrap(ASTNode, ASTNode, CodeStyleSettings, Wrap, ReservedWrapsProvider)}. + *

+ * Thread-safe. + * + * @author Denis Zhdanov + * @since Apr 21, 2010 2:30:29 PM + */ +public class JavaChildWrapArranger { + + /** + * Provides implementation of {@link JavaWrapManager#arrangeChildWrap(ASTNode, ASTNode, CodeStyleSettings, Wrap, ReservedWrapsProvider)} + * method. + * + * @param child child node which {@link Wrap wrap} is to be defined + * @param parent direct or indirect parent of the given 'child' node. Defines usage context + * of 'child' node processing + * @param settings code style settings to use during wrap definition + * @param suggestedWrap wrap suggested to use by clients of current class. I.e. those clients offer wrap to + * use based on their information about current processing state. However, it's possible + * that they don't know details of fine-grained wrap definition algorithm encapsulated + * at the current class. Hence, this method takes suggested wrap into consideration but + * is not required to use it all the time node based on the given parameters + * @param reservedWrapsProvider reserved {@code 'element type -> wrap instance'} mappings provider. Note: this + * argument is considered to be a part of legacy heritage and is intended to be removed as + * soon as formatting code refactoring is done + * @return wrap to use for the given 'child' node if it's possible to define the one; + * null otherwise + */ + @SuppressWarnings({"MethodMayBeStatic"}) + @Nullable + public Wrap arrange(ASTNode child, ASTNode parent, CodeStyleSettings settings, Wrap suggestedWrap, + ReservedWrapsProvider reservedWrapsProvider) + { + final ASTNode directParent = child.getTreeParent(); + int role = ((CompositeElement)directParent).getChildRole(child); + final IElementType nodeType = parent.getElementType(); + if (nodeType == JavaElementType.BINARY_EXPRESSION) { + if (role == ChildRole.OPERATION_SIGN && !settings.BINARY_OPERATION_SIGN_ON_NEXT_LINE) return null; + if (role == ChildRole.ROPERAND && settings.BINARY_OPERATION_SIGN_ON_NEXT_LINE) return null; + return suggestedWrap; + } + final IElementType childType = child.getElementType(); + if (childType == JavaElementType.EXTENDS_LIST || childType == JavaElementType.IMPLEMENTS_LIST) { + return Wrap.createWrap(settings.EXTENDS_KEYWORD_WRAP, true); + } + else if (childType == JavaElementType.THROWS_LIST) { + return Wrap.createWrap(settings.THROWS_KEYWORD_WRAP, true); + } + else if (nodeType == JavaElementType.EXTENDS_LIST || nodeType == JavaElementType.IMPLEMENTS_LIST) { + if (role == ChildRole.REFERENCE_IN_LIST) { + return suggestedWrap; + } + else { + return null; + } + } + else if (nodeType == JavaElementType.THROWS_LIST) { + if (role == ChildRole.REFERENCE_IN_LIST) { + return suggestedWrap; + } + else { + return null; + } + } + else if (nodeType == JavaElementType.CONDITIONAL_EXPRESSION) { + if (role == ChildRole.COLON && !settings.TERNARY_OPERATION_SIGNS_ON_NEXT_LINE) return null; + if (role == ChildRole.QUEST && !settings.TERNARY_OPERATION_SIGNS_ON_NEXT_LINE) return null; + if (role == ChildRole.THEN_EXPRESSION && settings.TERNARY_OPERATION_SIGNS_ON_NEXT_LINE) return null; + if (role == ChildRole.ELSE_EXPRESSION && settings.TERNARY_OPERATION_SIGNS_ON_NEXT_LINE) return null; + return suggestedWrap; + + } + + else if (FormattingAstUtil.isAssignment(parent)) { + if (role == ChildRole.INITIALIZER_EQ && settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return suggestedWrap; + if (role == ChildRole.INITIALIZER_EQ && !settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return null; + if (role == ChildRole.OPERATION_SIGN && settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return suggestedWrap; + if (role == ChildRole.OPERATION_SIGN && !settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return null; + if (role == ChildRole.INITIALIZER && !settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return suggestedWrap; + if (role == ChildRole.INITIALIZER && settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return null; + if (role == ChildRole.ROPERAND && !settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return suggestedWrap; + if (role == ChildRole.ROPERAND && settings.PLACE_ASSIGNMENT_SIGN_ON_NEXT_LINE) return null; + if (role == ChildRole.CLOSING_SEMICOLON) return null; + //if (role == ChildRole.TYPE) return suggestedWrap; + return suggestedWrap; + } + + else if (nodeType == JavaElementType.REFERENCE_EXPRESSION) { + if (role == ChildRole.DOT) { + return reservedWrapsProvider.getReservedWrap(JavaElementType.REFERENCE_EXPRESSION); + } + else { + return suggestedWrap; + } + } + else if (nodeType == JavaElementType.FOR_STATEMENT) { + if (role == ChildRole.FOR_INITIALIZATION || role == ChildRole.CONDITION || role == ChildRole.FOR_UPDATE) { + return suggestedWrap; + } + if (role == ChildRole.LOOP_BODY) { + final boolean dontWrap = (childType == JavaElementType.CODE_BLOCK || childType == JavaElementType.BLOCK_STATEMENT) && + settings.BRACE_STYLE == CodeStyleSettings.END_OF_LINE; + return Wrap.createWrap(dontWrap ? WrapType.NONE : WrapType.NORMAL, true); + } + else { + return null; + } + + } + + else if (nodeType == JavaElementType.METHOD) { + if (role == ChildRole.THROWS_LIST) { + return suggestedWrap; + } + else { + return null; + } + } + + else if (nodeType == JavaElementType.MODIFIER_LIST) { + if (childType == JavaElementType.ANNOTATION) { + return reservedWrapsProvider.getReservedWrap(JavaElementType.MODIFIER_LIST); + } + ASTNode prevElement = FormattingAstUtil.getPrevElement(child); + if (prevElement != null && prevElement.getElementType() == JavaElementType.ANNOTATION) { + return reservedWrapsProvider.getReservedWrap(JavaElementType.MODIFIER_LIST); + } + else { + return null; + } + } + else if (nodeType == JavaElementType.ASSERT_STATEMENT) { + if (role == ChildRole.CONDITION) { + return suggestedWrap; + } + if (role == ChildRole.ASSERT_DESCRIPTION && !settings.ASSERT_STATEMENT_COLON_ON_NEXT_LINE) { + return suggestedWrap; + } + if (role == ChildRole.COLON && settings.ASSERT_STATEMENT_COLON_ON_NEXT_LINE) { + return suggestedWrap; + } + return null; + } + else if (nodeType == JavaElementType.CODE_BLOCK) { + if (role == ChildRole.STATEMENT_IN_BLOCK) { + return suggestedWrap; + } + else { + return null; + } + } + + else if (nodeType == JavaElementType.IF_STATEMENT) { + if (childType == JavaElementType.IF_STATEMENT && role == ChildRole.ELSE_BRANCH && settings.SPECIAL_ELSE_IF_TREATMENT) { + return Wrap.createWrap(WrapType.NONE, false); + } + if (role == ChildRole.THEN_BRANCH || role == ChildRole.ELSE_BRANCH) { + if (childType == JavaElementType.BLOCK_STATEMENT) { + return null; + } + else { + return Wrap.createWrap(WrapType.NORMAL, true); + } + } + } + + else if (nodeType == JavaElementType.FOREACH_STATEMENT || nodeType == JavaElementType.WHILE_STATEMENT) { + if (role == ChildRole.LOOP_BODY) { + if (childType == JavaElementType.BLOCK_STATEMENT) { + return null; + } + else { + return Wrap.createWrap(WrapType.NORMAL, true); + } + } + } + + else if (nodeType == JavaElementType.DO_WHILE_STATEMENT) { + if (role == ChildRole.LOOP_BODY) { + return Wrap.createWrap(WrapType.NORMAL, true); + } else if (role == ChildRole.WHILE_KEYWORD) { + return Wrap.createWrap(WrapType.NORMAL, true); + } + } else if (nodeType == JavaElementType.ANNOTATION_ARRAY_INITIALIZER) { + if (suggestedWrap != null) { + return suggestedWrap; + } + if (role == ChildRole.ANNOTATION_VALUE) { + return Wrap.createWrap(WrapType.NORMAL, true); + } + } + + return suggestedWrap; + } +}