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

OC: check usages of public members of @Serializable classes

Browse Source
This commit is contained in:
Max Medvedev
2014-12-08 12:35:23 +03:00
parent 73bf7f0273
commit e5cda859f1
4 changed files with 94 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/devkit/resources/META-INF/plugin.xml
+5
View File
@@ -132,6 +132,11 @@
groupKey="inspections.group.name"
enabledByDefault="true" level="WARNING"
implementationClass="org.jetbrains.idea.devkit.inspections.internal.UseVirtualFileEqualsInspection"/>
<localInspection language="JAVA" shortName="OCSerializableCheck" displayName="Don't use explicitly serialization-only members"
groupKey="inspections.group.name"
enabledByDefault="false" level="ERROR"
implementationClass="org.jetbrains.idea.devkit.inspections.internal.OCSerializableCheckInspection"/>
<moduleConfigurationEditorProvider implementation="org.jetbrains.idea.devkit.module.PluginModuleEditorsProvider"/>
<implicitUsageProvider implementation="org.jetbrains.idea.devkit.inspections.DevKitImplicitUsageProvider"/>
plugins/devkit/resources/inspectionDescriptions/OCSerializableCheck.html
+5
View File
@@ -0,0 +1,5 @@
<html>
<body>
In OC we use a serialization mechanism which forces us to declare public fields and public constructors. The inspection checks these public members are not used explicitly in code.
</body>
</html>
plugins/devkit/resources/org/jetbrains/idea/devkit/DevKitBundle.properties
+1
View File
@@ -161,3 +161,4 @@ group.PluginDeployActions.text=Plugin Deployment Actions
error.cannot.resolve.plugin=Cannot resolve plugin {0}
create.description.file=Create Description File
select.target.location.of.description=Select target location of {0}
serialization.only.member.used.explicitly=Serialization-only member used explicitly
plugins/devkit/src/inspections/internal/OCSerializableCheckInspection.java
+83
View File
@@ -0,0 +1,83 @@
/*
* 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.
*/
package org.jetbrains.idea.devkit.inspections.internal;
import com.intellij.codeInspection.ProblemHighlightType;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiTreeUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.idea.devkit.DevKitBundle;
/**
* Created by Max Medvedev on 07/12/14
*/
public class OCSerializableCheckInspection extends InternalInspection {
public static final String SERIALIZABLE = "com.jetbrains.objc.symbols.Serializable";
@Override
public PsiElementVisitor buildInternalVisitor(@NotNull final ProblemsHolder holder, boolean isOnTheFly) {
return new JavaElementVisitor() {
@Override
public void visitNewExpression(PsiNewExpression expression) {
super.visitNewExpression(expression);
PsiMethod constructor = expression.resolveConstructor();
if (constructor != null && constructor.getParameterList().getParametersCount() == 0) {
checkSerializable(constructor, expression);
}
}
@Override
public void visitReferenceExpression(PsiReferenceExpression expression) {
super.visitReferenceExpression(expression);
PsiElement resolved = expression.resolve();
if (resolved instanceof PsiField) {
PsiElement nameElement = expression.getReferenceNameElement();
if (nameElement != null) {
checkSerializable((PsiField)resolved, nameElement);
}
}
}
private void checkSerializable(@NotNull PsiMember member, @NotNull PsiElement place) {
if (member.hasModifierProperty(PsiModifier.PUBLIC) && !isInInitializer(place)) {
PsiClass aClass = member.getContainingClass();
if (aClass != null && !PsiTreeUtil.isAncestor(aClass, place, true)) {
PsiModifierList modifierList = aClass.getModifierList();
if (modifierList != null && modifierList.findAnnotation(SERIALIZABLE) != null) {
String message = DevKitBundle.message("serialization.only.member.used.explicitly");
holder.registerProblem(place, message, ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
}
}
}
}
};
}
private static boolean isInInitializer(PsiElement place) {
while (true) {
place = PsiTreeUtil.getParentOfType(place, PsiClass.class);
if (place == null) return false;
String name = ((PsiClass)place).getName();
if (name != null && name.contains("Serializer")) {
return true;
}
}
}
}