PageRenderTime 40ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/plugins/groovy/groovy-psi/src/org/jetbrains/plugins/groovy/lang/psi/impl/utils/ParenthesesUtils.java

http://github.com/JetBrains/intellij-community
Java | 208 lines | 172 code | 26 blank | 10 comment | 25 complexity | 5f5042b879b2a48d514c4663f57ab63a MD5 | raw file
Possible License(s): BSD-3-Clause, Apache-2.0, MPL-2.0-no-copyleft-exception, MIT, EPL-1.0, AGPL-1.0
  1. // Copyright 2000-2019 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.
  2. package org.jetbrains.plugins.groovy.lang.psi.impl.utils;
  3. import com.intellij.psi.PsiElement;
  4. import com.intellij.psi.tree.IElementType;
  5. import org.jetbrains.annotations.NotNull;
  6. import org.jetbrains.annotations.Nullable;
  7. import org.jetbrains.plugins.groovy.lang.lexer.GroovyTokenTypes;
  8. import org.jetbrains.plugins.groovy.lang.parser.GroovyElementTypes;
  9. import org.jetbrains.plugins.groovy.lang.psi.GroovyPsiElementFactory;
  10. import org.jetbrains.plugins.groovy.lang.psi.api.statements.arguments.GrArgumentList;
  11. import org.jetbrains.plugins.groovy.lang.psi.api.statements.expressions.*;
  12. import java.util.HashMap;
  13. import java.util.Map;
  14. /**
  15. * Precedence documentation - http://groovy-lang.org/operators.html#_operator_precedence
  16. */
  17. public class ParenthesesUtils {
  18. private ParenthesesUtils() {
  19. }
  20. private static final int PARENTHESIZED_PRECEDENCE;
  21. private static final int NEW_EXPR_PRECEDENCE;
  22. private static final int LITERAL_PRECEDENCE;
  23. public static final int METHOD_CALL_PRECEDENCE;
  24. private static final int POSTFIX_PRECEDENCE;
  25. public static final int PREFIX_PRECEDENCE;
  26. public static final int TYPE_CAST_PRECEDENCE;
  27. public static final int EXPONENTIAL_PRECEDENCE;
  28. public static final int MULTIPLICATIVE_PRECEDENCE;
  29. private static final int ADDITIVE_PRECEDENCE;
  30. private static final int SHIFT_PRECEDENCE;
  31. private static final int RANGE_PRECEDENCE;
  32. public static final int INSTANCEOF_PRECEDENCE;
  33. public static final int RELATIONAL_PRECEDENCE;
  34. public static final int EQUALITY_PRECEDENCE;
  35. private static final int BINARY_AND_PRECEDENCE;
  36. private static final int BINARY_XOR_PRECEDENCE;
  37. private static final int BINARY_OR_PRECEDENCE;
  38. public static final int AND_PRECEDENCE;
  39. public static final int OR_PRECEDENCE;
  40. public static final int CONDITIONAL_PRECEDENCE;
  41. public static final int SAFE_CAST_PRECEDENCE;
  42. private static final int ASSIGNMENT_PRECEDENCE;
  43. private static final int APPLICATION_STMT_PRECEDENCE;
  44. static {
  45. int i = 0;
  46. PARENTHESIZED_PRECEDENCE = 0;
  47. LITERAL_PRECEDENCE = 0;
  48. NEW_EXPR_PRECEDENCE = 0;
  49. METHOD_CALL_PRECEDENCE = 0;
  50. TYPE_CAST_PRECEDENCE = i++;
  51. POSTFIX_PRECEDENCE = i++;
  52. EXPONENTIAL_PRECEDENCE = i++;
  53. PREFIX_PRECEDENCE = i++;
  54. MULTIPLICATIVE_PRECEDENCE = i++;
  55. ADDITIVE_PRECEDENCE = i++;
  56. SHIFT_PRECEDENCE = i++;
  57. RANGE_PRECEDENCE = i++;
  58. INSTANCEOF_PRECEDENCE = i++;
  59. RELATIONAL_PRECEDENCE = i++;
  60. EQUALITY_PRECEDENCE = i++;
  61. BINARY_AND_PRECEDENCE = i++;
  62. BINARY_XOR_PRECEDENCE = i++;
  63. BINARY_OR_PRECEDENCE = i++;
  64. AND_PRECEDENCE = i++;
  65. OR_PRECEDENCE = i++;
  66. CONDITIONAL_PRECEDENCE = i++;
  67. SAFE_CAST_PRECEDENCE = i++;
  68. ASSIGNMENT_PRECEDENCE = i++;
  69. APPLICATION_STMT_PRECEDENCE = i;
  70. }
  71. private static final Map<IElementType, Integer> BINARY_PRECEDENCES = new HashMap<>();
  72. static {
  73. BINARY_PRECEDENCES.put(GroovyTokenTypes.mPLUS, ADDITIVE_PRECEDENCE);
  74. BINARY_PRECEDENCES.put(GroovyTokenTypes.mMINUS, ADDITIVE_PRECEDENCE);
  75. BINARY_PRECEDENCES.put(GroovyTokenTypes.mSTAR, MULTIPLICATIVE_PRECEDENCE);
  76. BINARY_PRECEDENCES.put(GroovyTokenTypes.mDIV, MULTIPLICATIVE_PRECEDENCE);
  77. BINARY_PRECEDENCES.put(GroovyTokenTypes.mMOD, MULTIPLICATIVE_PRECEDENCE);
  78. BINARY_PRECEDENCES.put(GroovyTokenTypes.mSTAR_STAR, EXPONENTIAL_PRECEDENCE);
  79. BINARY_PRECEDENCES.put(GroovyTokenTypes.mLAND, AND_PRECEDENCE);
  80. BINARY_PRECEDENCES.put(GroovyTokenTypes.mLOR, OR_PRECEDENCE);
  81. BINARY_PRECEDENCES.put(GroovyTokenTypes.mBAND, BINARY_AND_PRECEDENCE);
  82. BINARY_PRECEDENCES.put(GroovyTokenTypes.mBOR, BINARY_OR_PRECEDENCE);
  83. BINARY_PRECEDENCES.put(GroovyTokenTypes.mBXOR, BINARY_XOR_PRECEDENCE);
  84. BINARY_PRECEDENCES.put(GroovyElementTypes.COMPOSITE_LSHIFT_SIGN, SHIFT_PRECEDENCE);
  85. BINARY_PRECEDENCES.put(GroovyElementTypes.COMPOSITE_RSHIFT_SIGN, SHIFT_PRECEDENCE);
  86. BINARY_PRECEDENCES.put(GroovyElementTypes.COMPOSITE_TRIPLE_SHIFT_SIGN, SHIFT_PRECEDENCE);
  87. BINARY_PRECEDENCES.put(GroovyTokenTypes.mRANGE_INCLUSIVE, RANGE_PRECEDENCE);
  88. BINARY_PRECEDENCES.put(GroovyTokenTypes.mRANGE_EXCLUSIVE, RANGE_PRECEDENCE);
  89. BINARY_PRECEDENCES.put(GroovyTokenTypes.mGT, RELATIONAL_PRECEDENCE);
  90. BINARY_PRECEDENCES.put(GroovyTokenTypes.mGE, RELATIONAL_PRECEDENCE);
  91. BINARY_PRECEDENCES.put(GroovyTokenTypes.mLT, RELATIONAL_PRECEDENCE);
  92. BINARY_PRECEDENCES.put(GroovyTokenTypes.mLE, RELATIONAL_PRECEDENCE);
  93. BINARY_PRECEDENCES.put(GroovyTokenTypes.mEQUAL, EQUALITY_PRECEDENCE);
  94. BINARY_PRECEDENCES.put(GroovyTokenTypes.kIN, RELATIONAL_PRECEDENCE);
  95. BINARY_PRECEDENCES.put(GroovyTokenTypes.mNOT_EQUAL, EQUALITY_PRECEDENCE);
  96. BINARY_PRECEDENCES.put(GroovyTokenTypes.mCOMPARE_TO, EQUALITY_PRECEDENCE);
  97. BINARY_PRECEDENCES.put(GroovyTokenTypes.kAS, SAFE_CAST_PRECEDENCE);
  98. BINARY_PRECEDENCES.put(GroovyTokenTypes.mREGEX_FIND, EQUALITY_PRECEDENCE);
  99. BINARY_PRECEDENCES.put(GroovyTokenTypes.mREGEX_MATCH, EQUALITY_PRECEDENCE);
  100. }
  101. public static int precedenceForBinaryOperator(@NotNull IElementType sign) {
  102. Integer result = BINARY_PRECEDENCES.get(sign);
  103. return result != null ? result : 0;
  104. }
  105. public static int getPrecedence(GrExpression expr) {
  106. if (expr instanceof GrUnaryExpression) return ((GrUnaryExpression)expr).isPostfix() ? POSTFIX_PRECEDENCE : PREFIX_PRECEDENCE;
  107. if (expr instanceof GrTypeCastExpression) return TYPE_CAST_PRECEDENCE;
  108. if (expr instanceof GrConditionalExpression) return CONDITIONAL_PRECEDENCE;
  109. if (expr instanceof GrSafeCastExpression) return SAFE_CAST_PRECEDENCE;
  110. if (expr instanceof GrAssignmentExpression) return ASSIGNMENT_PRECEDENCE;
  111. if (expr instanceof GrApplicationStatement) return APPLICATION_STMT_PRECEDENCE;
  112. if (expr instanceof GrInstanceOfExpression) return INSTANCEOF_PRECEDENCE;
  113. if (expr instanceof GrNewExpression) return NEW_EXPR_PRECEDENCE;
  114. if (expr instanceof GrParenthesizedExpression) return PARENTHESIZED_PRECEDENCE;
  115. if (expr instanceof GrReferenceExpression) {
  116. final GrReferenceExpression referenceExpression = (GrReferenceExpression)expr;
  117. return referenceExpression.getQualifierExpression() == null ? LITERAL_PRECEDENCE : METHOD_CALL_PRECEDENCE;
  118. }
  119. if (expr instanceof GrBinaryExpression) {
  120. final IElementType opToken = ((GrBinaryExpression)expr).getOperationTokenType();
  121. return precedenceForBinaryOperator(opToken);
  122. }
  123. return 0;
  124. }
  125. @NotNull
  126. public static GrExpression parenthesize(@NotNull GrExpression expression) {
  127. return parenthesize(expression, null);
  128. }
  129. @NotNull
  130. public static GrExpression parenthesize(@NotNull GrExpression expression, @Nullable PsiElement context) {
  131. GroovyPsiElementFactory factory = GroovyPsiElementFactory.getInstance(expression.getProject());
  132. return factory.createParenthesizedExpr(expression, context);
  133. }
  134. @NotNull
  135. public static GrExpression unparenthesize(@NotNull GrExpression expression) {
  136. GrExpression currentExpression = expression;
  137. while (currentExpression instanceof GrParenthesizedExpression) {
  138. GrExpression operand = ((GrParenthesizedExpression)currentExpression).getOperand();
  139. if (operand != null) {
  140. currentExpression = operand;
  141. } else {
  142. return currentExpression;
  143. }
  144. }
  145. return currentExpression;
  146. }
  147. /**
  148. * @return {@code true} if operator with childPrecedence
  149. * on the right or left (isRhs) side
  150. * inside operator with parentToken
  151. * should be parenthesized
  152. */
  153. public static boolean checkPrecedenceForBinaryOps(int childPrecedence, @NotNull IElementType parentToken, boolean isRhs) {
  154. int parentPrecedence = precedenceForBinaryOperator(parentToken);
  155. return parentPrecedence < childPrecedence ||
  156. parentPrecedence == childPrecedence && parentPrecedence != 0 && isRhs;
  157. }
  158. public static boolean checkPrecedenceForNonBinaryOps(@NotNull GrExpression newExpr, int parentPrecedence) {
  159. return checkPrecedenceForNonBinaryOps(getPrecedence(newExpr), parentPrecedence);
  160. }
  161. public static boolean checkPrecedenceForNonBinaryOps(int precedence, int parentPrecedence) {
  162. return precedence > parentPrecedence;
  163. }
  164. public static boolean checkPrecedence(int precedence, @NotNull GrExpression oldExpr) {
  165. PsiElement parent = oldExpr.getParent();
  166. if (parent instanceof GrArgumentList) {
  167. parent = parent.getParent();
  168. }
  169. if (!(parent instanceof GrExpression)) return false;
  170. GrExpression oldParent = (GrExpression) parent;
  171. if (oldParent instanceof GrBinaryExpression) {
  172. GrBinaryExpression binaryExpression = (GrBinaryExpression)oldParent;
  173. GrExpression rightOperand = binaryExpression.getRightOperand();
  174. return checkPrecedenceForBinaryOps(precedence, binaryExpression.getOperationTokenType(), oldExpr.equals(rightOperand));
  175. } else {
  176. return checkPrecedenceForNonBinaryOps(precedence, getPrecedence(oldParent));
  177. }
  178. }
  179. public static boolean checkPrecedence(@NotNull GrExpression newExpr, @NotNull GrExpression oldExpr) {
  180. return checkPrecedence(getPrecedence(newExpr), oldExpr);
  181. }
  182. }