Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnton Gorenkov2011-07-06 02:12:45 -0400
committerMarc-Andre Laperle2011-07-06 02:34:49 -0400
commit3b6f6642b801502b9c6125aec81bcc82213014c6 (patch)
tree9c7489c6f4fee8f2d21abd6e5a5cccf19638fff6 /codan/org.eclipse.cdt.codan.checkers
parent82a3d0c2809615e92303ce430ada5f5840ef9333 (diff)
downloadorg.eclipse.cdt-3b6f6642b801502b9c6125aec81bcc82213014c6.tar.gz
org.eclipse.cdt-3b6f6642b801502b9c6125aec81bcc82213014c6.tar.xz
org.eclipse.cdt-3b6f6642b801502b9c6125aec81bcc82213014c6.zip
Bug 339795 - [checker] Checker that finds class members that are not
initialized in constructor
Diffstat (limited to 'codan/org.eclipse.cdt.codan.checkers')
-rw-r--r--codan/org.eclipse.cdt.codan.checkers/OSGI-INF/l10n/bundle.properties6
-rw-r--r--codan/org.eclipse.cdt.codan.checkers/plugin.xml14
-rw-r--r--codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.java3
-rw-r--r--codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.properties3
-rw-r--r--codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/ClassMembersInitializationChecker.java222
5 files changed, 245 insertions, 3 deletions
diff --git a/codan/org.eclipse.cdt.codan.checkers/OSGI-INF/l10n/bundle.properties b/codan/org.eclipse.cdt.codan.checkers/OSGI-INF/l10n/bundle.properties
index a59ba9ebeb..3d003daed3 100644
--- a/codan/org.eclipse.cdt.codan.checkers/OSGI-INF/l10n/bundle.properties
+++ b/codan/org.eclipse.cdt.codan.checkers/OSGI-INF/l10n/bundle.properties
@@ -1,5 +1,5 @@
###############################################################################
-# Copyright (c) 2010 Alena Laskavaia and others.
+# Copyright (c) 2010, 2011 Alena Laskavaia and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@@ -111,6 +111,10 @@ checker.name.AbstractClassCreation = Abstract class cannot be instantiated
problem.name.AbstractClassCreation = Abstract class cannot be instantiated
problem.messagePattern.AbstractClassCreation = The type ''{0}'' must implement the inherited pure virtual method ''{1}''
problem.description.AbstractClassCreation = All inherited pure virtual methods must be implemented to allow instantiation of the class
+checker.name.ClassMembersInitialization = Class members should be properly initialized
+problem.name.ClassMembersInitialization = Class members should be properly initialized
+problem.messagePattern.ClassMembersInitialization = Member ''{0}'' was not initialized in this constructor
+problem.description.ClassMembersInitialization = Class members should be properly initialized to avoid random behavior
checker.name.UnusedSymbolInFileScopeChecker = Unused symbols and declarations in file scope
problem.description.UnusedVariableDeclarationProblem = Finds unused global variable declarations in file scope
diff --git a/codan/org.eclipse.cdt.codan.checkers/plugin.xml b/codan/org.eclipse.cdt.codan.checkers/plugin.xml
index b8e6b7f915..0f3f1c7667 100644
--- a/codan/org.eclipse.cdt.codan.checkers/plugin.xml
+++ b/codan/org.eclipse.cdt.codan.checkers/plugin.xml
@@ -384,5 +384,19 @@
name="%problem.name.UnusedStaticFunctionProblem">
</problem>
</checker>
+ <checker
+ class="org.eclipse.cdt.codan.internal.checkers.ClassMembersInitializationChecker"
+ id="org.eclipse.cdt.codan.internal.checkers.ClassMembersInitialization"
+ name="%checker.name.ClassMembersInitialization">
+ <problem
+ category="org.eclipse.cdt.codan.core.categories.ProgrammingProblems"
+ defaultEnabled="true"
+ defaultSeverity="Warning"
+ description="%problem.description.ClassMembersInitialization"
+ id="org.eclipse.cdt.codan.internal.checkers.ClassMembersInitialization"
+ messagePattern="%problem.messagePattern.ClassMembersInitialization"
+ name="%problem.name.ClassMembersInitialization">
+ </problem>
+ </checker>
</extension>
</plugin>
diff --git a/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.java b/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.java
index ee770a93c8..8a4ad7e687 100644
--- a/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.java
+++ b/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2009,2010 Alena Laskavaia
+ * Copyright (c) 2009, 2011 Alena Laskavaia
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -20,6 +20,7 @@ public class CheckersMessages extends NLS {
public static String CaseBreakChecker_EmptyCaseDescription;
public static String CaseBreakChecker_LastCaseDescription;
public static String CatchByReference_ReportForUnknownType;
+ public static String ClassMembersInitializationChecker_SkipConstructorsWithFCalls;
public static String NamingConventionFunctionChecker_LabelNamePattern;
public static String NamingConventionFunctionChecker_ParameterMethods;
public static String ReturnChecker_Param0;
diff --git a/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.properties b/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.properties
index 2aefeb0333..b219b977cf 100644
--- a/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.properties
+++ b/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/CheckersMessages.properties
@@ -1,5 +1,5 @@
###############################################################################
-# Copyright (c) 2010 Alena Laskavaia and others.
+# Copyright (c) 2010, 2011 Alena Laskavaia and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at
@@ -11,6 +11,7 @@
CaseBreakChecker_DefaultNoBreakCommentDescription=Comment text to suppress the problem (regular expression):
CaseBreakChecker_EmptyCaseDescription=Check also empty case statement (except if last)
CaseBreakChecker_LastCaseDescription=Check also the last case statement
+ClassMembersInitializationChecker_SkipConstructorsWithFCalls=Skip constructors with initialization function calls
CatchByReference_ReportForUnknownType=Report a problem if type cannot be resolved
NamingConventionFunctionChecker_LabelNamePattern=Name Pattern
NamingConventionFunctionChecker_ParameterMethods=Also check C++ method names
diff --git a/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/ClassMembersInitializationChecker.java b/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/ClassMembersInitializationChecker.java
new file mode 100644
index 0000000000..c0d16049b3
--- /dev/null
+++ b/codan/org.eclipse.cdt.codan.checkers/src/org/eclipse/cdt/codan/internal/checkers/ClassMembersInitializationChecker.java
@@ -0,0 +1,222 @@
+/*******************************************************************************
+ * Copyright (c) 2011 Anton Gorenkov
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Anton Gorenkov - initial implementation
+ *******************************************************************************/
+package org.eclipse.cdt.codan.internal.checkers;
+
+import java.util.Stack;
+import java.util.HashSet;
+import java.util.Set;
+
+import org.eclipse.cdt.codan.core.cxx.model.AbstractIndexAstChecker;
+import org.eclipse.cdt.codan.core.model.IProblemWorkingCopy;
+import org.eclipse.cdt.core.dom.ast.ASTVisitor;
+import org.eclipse.cdt.core.dom.ast.IASTDeclaration;
+import org.eclipse.cdt.core.dom.ast.IASTExpression;
+import org.eclipse.cdt.core.dom.ast.IASTFunctionCallExpression;
+import org.eclipse.cdt.core.dom.ast.IASTIdExpression;
+import org.eclipse.cdt.core.dom.ast.IASTInitializerClause;
+import org.eclipse.cdt.core.dom.ast.IASTLiteralExpression;
+import org.eclipse.cdt.core.dom.ast.IASTName;
+import org.eclipse.cdt.core.dom.ast.IASTNode;
+import org.eclipse.cdt.core.dom.ast.IASTTranslationUnit;
+import org.eclipse.cdt.core.dom.ast.IBasicType;
+import org.eclipse.cdt.core.dom.ast.IBinding;
+import org.eclipse.cdt.core.dom.ast.ICompositeType;
+import org.eclipse.cdt.core.dom.ast.IEnumeration;
+import org.eclipse.cdt.core.dom.ast.IField;
+import org.eclipse.cdt.core.dom.ast.IPointerType;
+import org.eclipse.cdt.core.dom.ast.IType;
+import org.eclipse.cdt.core.dom.ast.ITypedef;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPASTFunctionDefinition;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPASTUnaryExpression;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPClassType;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPConstructor;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPFunction;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPMethod;
+import org.eclipse.cdt.core.dom.ast.cpp.ICPPReferenceType;
+import org.eclipse.cdt.internal.core.dom.parser.cpp.semantics.CPPVariableReadWriteFlags;
+import org.eclipse.cdt.internal.core.pdom.dom.PDOMName;
+
+/**
+ * Checks that class members of simple types (int, float, pointers,
+ * enumeration types, ...) are properly initialized in constructor.
+ * Not initialized members may cause to unstable or random behavior
+ * of methods that are working with their value.
+ *
+ * @author Anton Gorenkov
+ *
+ */
+public class ClassMembersInitializationChecker extends AbstractIndexAstChecker {
+ public static final String ER_ID = "org.eclipse.cdt.codan.internal.checkers.ClassMembersInitialization"; //$NON-NLS-1$
+ public static final String PARAM_SKIP = "skip"; //$NON-NLS-1$
+
+ public void processAst(IASTTranslationUnit ast) {
+ ast.accept(new OnEachClass());
+ }
+
+ class OnEachClass extends ASTVisitor {
+
+ // NOTE: Classes can be nested and even can be declared in constructors of the other classes
+ private Stack< Set<IField> > constructorsStack = new Stack< Set<IField> >();
+
+ OnEachClass() {
+ shouldVisitDeclarations = true;
+ shouldVisitNames = true;
+ shouldVisitExpressions = skipConstructorsWithFCalls();
+ }
+
+ public int visit(IASTDeclaration declaration) {
+ ICPPConstructor constructor = getConstructor(declaration);
+ if (constructor != null) {
+ Set<IField> fieldsInConstructor = constructorsStack.push(new HashSet<IField>());
+
+ // Add all class fields
+ for (IField field : constructor.getClassOwner().getDeclaredFields()) {
+ if (isSimpleType(field.getType()) && !field.isStatic()) {
+ fieldsInConstructor.add(field);
+ }
+ }
+ }
+ return PROCESS_CONTINUE;
+ }
+
+ public int leave(IASTDeclaration declaration) {
+ if (getConstructor(declaration) != null) {
+ for (IField field : constructorsStack.pop()) {
+ reportProblem(ER_ID, declaration, field.getName());
+ }
+ }
+ return PROCESS_CONTINUE;
+ }
+
+ public int visit(IASTExpression expression) {
+ if (!constructorsStack.empty() && expression instanceof IASTFunctionCallExpression) {
+ Set<IField> actualContructorFields = constructorsStack.peek();
+ if (!actualContructorFields.isEmpty()) {
+ boolean skipCurrentConstructor = false;
+ IASTFunctionCallExpression fCall = (IASTFunctionCallExpression)expression;
+ IASTExpression fNameExp = fCall.getFunctionNameExpression();
+ if (fNameExp instanceof IASTIdExpression) {
+ IASTIdExpression fName = (IASTIdExpression)fNameExp;
+ IBinding fBinding = fName.getName().resolveBinding();
+ if (fBinding instanceof ICPPMethod) {
+ ICPPMethod method = (ICPPMethod)fBinding;
+ ICompositeType constructorOwner = actualContructorFields.iterator().next().getCompositeTypeOwner();
+ if (constructorOwner == method.getClassOwner() && !method.getType().isConst()) {
+ skipCurrentConstructor = true;
+ }
+ } else if (fBinding instanceof ICPPFunction) {
+ for (IASTInitializerClause argument : fCall.getArguments()) {
+ if (referencesThis(argument)) {
+ skipCurrentConstructor = true;
+ break;
+ }
+ }
+ }
+ }
+ if (skipCurrentConstructor) {
+ constructorsStack.peek().clear();
+ }
+ }
+ }
+ return PROCESS_CONTINUE;
+ }
+
+ /** Checks whether expression references this (directly, by pointer or by reference)
+ *
+ */
+ public boolean referencesThis(IASTNode expr) {
+ if (expr instanceof IASTLiteralExpression) {
+ IASTLiteralExpression litArg = (IASTLiteralExpression)expr;
+ if (litArg.getKind() == IASTLiteralExpression.lk_this) {
+ return true;
+ }
+ } else if (expr instanceof ICPPASTUnaryExpression) {
+ ICPPASTUnaryExpression unExpr = (ICPPASTUnaryExpression)expr;
+ switch (unExpr.getOperator()) {
+ case ICPPASTUnaryExpression.op_amper:
+ case ICPPASTUnaryExpression.op_star:
+ case ICPPASTUnaryExpression.op_bracketedPrimary:
+ return referencesThis(unExpr.getOperand());
+ }
+ }
+ return false;
+ }
+
+ public int visit(IASTName name) {
+ if (!constructorsStack.empty()) {
+ Set<IField> actualContructorFields = constructorsStack.peek();
+ if (!actualContructorFields.isEmpty()) {
+ IBinding binding = name.resolveBinding();
+ if (actualContructorFields.contains(binding)) {
+ if ((CPPVariableReadWriteFlags.getReadWriteFlags(name) & PDOMName.WRITE_ACCESS) != 0) {
+ actualContructorFields.remove(binding);
+ }
+ }
+ }
+ }
+ return PROCESS_CONTINUE;
+ }
+
+ /** Checks whether class member of the specified type should be initialized
+ *
+ * @param type Type to check
+ * @return true if type is:
+ * - basic type (int, float, ...)
+ * - pointer
+ * - enum
+ * - reference (should be initialized in initialization list)
+ * - typedef to the another native type.
+ *
+ * @note: Not supported types (but maybe should be):
+ * - array
+ * - union
+ * - unknown type (need user preference?)
+ * - template parameter (need user preference?)
+ */
+ private boolean isSimpleType(IType type) {
+ return (type instanceof IBasicType ||
+ type instanceof IPointerType ||
+ type instanceof IEnumeration ||
+ type instanceof ICPPReferenceType ||
+ (type instanceof ITypedef && isSimpleType( ((ITypedef)type).getType()) ) );
+ }
+
+ /** Checks that specified declaration is a class constructor
+ * (it is a class member and its name is equal to class name)
+ */
+ private ICPPConstructor getConstructor(IASTDeclaration decl) {
+ if (decl instanceof ICPPASTFunctionDefinition) {
+ ICPPASTFunctionDefinition functionDefinition = (ICPPASTFunctionDefinition)decl;
+ IBinding binding = functionDefinition.getDeclarator().getName().resolveBinding();
+ if (binding instanceof ICPPConstructor) {
+ ICPPConstructor constructor = (ICPPConstructor) binding;
+ if (constructor.getClassOwner().getKey()!=ICPPClassType.k_union) {
+ return constructor;
+ }
+ }
+ }
+
+ return null;
+ }
+
+ }
+
+ @Override
+ public void initPreferences(IProblemWorkingCopy problem) {
+ super.initPreferences(problem);
+ addPreference(problem, PARAM_SKIP, CheckersMessages.ClassMembersInitializationChecker_SkipConstructorsWithFCalls, Boolean.TRUE);
+ }
+
+ public boolean skipConstructorsWithFCalls() {
+ return (Boolean) getPreference(getProblemById(ER_ID, getFile()), PARAM_SKIP);
+ }
+
+}

Back to the top