1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
/*
* Copyright 2013-2014 Bas Leijdekkers
*
* 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.siyeh.ig.logging;
import com.intellij.psi.*;
import com.intellij.psi.util.InheritanceUtil;
import com.intellij.util.containers.ContainerUtilRt;
import com.siyeh.InspectionGadgetsBundle;
import com.siyeh.ig.BaseInspection;
import com.siyeh.ig.BaseInspectionVisitor;
import com.siyeh.ig.psiutils.ExpressionUtils;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import java.util.Set;
public class PlaceholderCountMatchesArgumentCountInspection extends BaseInspection {
@NonNls
private static final Set<String> loggingMethodNames = ContainerUtilRt.newHashSet("trace", "debug", "info", "warn", "error");
@Nls
@NotNull
@Override
public String getDisplayName() {
return InspectionGadgetsBundle.message("placeholder.count.matches.argument.count.display.name");
}
@NotNull
@Override
protected String buildErrorString(Object... infos) {
final Integer argumentCount = (Integer)infos[0];
final Integer placeholderCount = (Integer)infos[1];
if (argumentCount.intValue() > placeholderCount.intValue()) {
return InspectionGadgetsBundle.message("placeholder.count.matches.argument.count.more.problem.descriptor",
argumentCount, placeholderCount);
}
else {
return InspectionGadgetsBundle.message("placeholder.count.matches.argument.count.fewer.problem.descriptor",
argumentCount, placeholderCount);
}
}
@Override
public BaseInspectionVisitor buildVisitor() {
return new PlaceholderCountMatchesArgumentCountVisitor();
}
private static class PlaceholderCountMatchesArgumentCountVisitor extends BaseInspectionVisitor {
@Override
public void visitMethodCallExpression(PsiMethodCallExpression expression) {
super.visitMethodCallExpression(expression);
final PsiReferenceExpression methodExpression = expression.getMethodExpression();
final String name = methodExpression.getReferenceName();
if (!loggingMethodNames.contains(name)) {
return;
}
final PsiMethod method = expression.resolveMethod();
if (method == null) {
return;
}
final PsiClass aClass = method.getContainingClass();
if (!InheritanceUtil.isInheritor(aClass, "org.slf4j.Logger")) {
return;
}
final PsiExpressionList argumentList = expression.getArgumentList();
final PsiExpression[] arguments = argumentList.getExpressions();
if (arguments.length == 0) {
return;
}
final PsiExpression firstArgument = arguments[0];
final int placeholderCount;
final int argumentCount;
if (InheritanceUtil.isInheritor(firstArgument.getType(), "org.slf4j.Marker")) {
if (arguments.length < 2) {
return;
}
final PsiExpression secondArgument = arguments[1];
placeholderCount = countPlaceholders(secondArgument);
argumentCount = countArguments(arguments, 2);
}
else {
placeholderCount = countPlaceholders(firstArgument);
argumentCount = countArguments(arguments, 1);
}
if (placeholderCount < 0 || argumentCount < 0 || placeholderCount == argumentCount) {
return;
}
registerMethodCallError(expression, Integer.valueOf(argumentCount), Integer.valueOf(placeholderCount));
}
private static boolean hasThrowableType(PsiExpression lastArgument) {
final PsiType type = lastArgument.getType();
if (type instanceof PsiDisjunctionType) {
final PsiDisjunctionType disjunctionType = (PsiDisjunctionType)type;
for (PsiType disjunction : disjunctionType.getDisjunctions()) {
if (!InheritanceUtil.isInheritor(disjunction, CommonClassNames.JAVA_LANG_THROWABLE)) {
return false;
}
}
return true;
}
return InheritanceUtil.isInheritor(type, CommonClassNames.JAVA_LANG_THROWABLE);
}
public static int countPlaceholders(PsiExpression argument) {
final Object value = ExpressionUtils.computeConstantExpression(argument);
if (!(value instanceof String)) {
return -1;
}
final String string = (String)value;
int count = 0;
int index = string.indexOf("{}");
while (index >= 0) {
if (index == 0 || string.charAt(index - 1) != '\\') {
count++;
}
index = string.indexOf("{}", index + 1);
}
return count;
}
private static int countArguments(PsiExpression[] arguments, int countFrom) {
if (arguments.length <= countFrom) {
return 0;
}
final int count = arguments.length - countFrom;
if (count == 1) {
final PsiExpression argument = arguments[countFrom];
final PsiType argumentType = argument.getType();
if (argumentType instanceof PsiArrayType) {
if (argumentType.equalsToText("java.lang.Object[]") && argument instanceof PsiNewExpression) {
final PsiNewExpression newExpression = (PsiNewExpression)argument;
final PsiArrayInitializerExpression arrayInitializerExpression = newExpression.getArrayInitializer();
if (arrayInitializerExpression != null) {
return arrayInitializerExpression.getInitializers().length;
}
}
return -1;
}
}
final PsiExpression lastArgument = arguments[arguments.length - 1];
return hasThrowableType(lastArgument) ? count - 1 : count;
}
}
}
|
