Generate equals & hashcode visitors that ignore comments #729

3 files changed, 167 insertions, 0 deletions

diff --git a/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/CoreGenerator.java b/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/CoreGenerator.java
index 64b5fd48f..2b59bd192 100644
--- a/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/CoreGenerator.java
+++ b/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/CoreGenerator.java
@@ -32,12 +32,14 @@ public class CoreGenerator {
         new GenericVisitorWithDefaultsGenerator(sourceRoot).generate();
         new EqualsVisitorGenerator(sourceRoot).generate();
         new ObjectIdentityEqualsVisitorGenerator(sourceRoot).generate();
+        new NoCommentEqualsVisitorGenerator(sourceRoot).generate();
         new VoidVisitorAdapterGenerator(sourceRoot).generate();
         new VoidVisitorGenerator(sourceRoot).generate();
         new VoidVisitorWithDefaultsGenerator(sourceRoot).generate();
         new GenericVisitorGenerator(sourceRoot).generate();
         new HashCodeVisitorGenerator(sourceRoot).generate();
         new ObjectIdentityHashCodeVisitorGenerator(sourceRoot).generate();
+        new NoCommentHashCodeVisitorGenerator(sourceRoot).generate();
         new CloneVisitorGenerator(sourceRoot).generate();
         new ModifierVisitorGenerator(sourceRoot).generate();
 
diff --git a/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/visitor/NoCommentEqualsVisitorGenerator.java b/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/visitor/NoCommentEqualsVisitorGenerator.java
new file mode 100644
index 000000000..f6174c4e6
--- /dev/null
+++ b/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/visitor/NoCommentEqualsVisitorGenerator.java
@@ -0,0 +1,76 @@
+/*

+ * Copyright (C) 2007-2010 Júlio Vilmar Gesser.

+ * Copyright (C) 2011, 2013-2016 The JavaParser Team.

+ *

+ * This file is part of JavaParser.

+ *

+ * JavaParser can be used either under the terms of

+ * a) the GNU Lesser General Public License as published by

+ *     the Free Software Foundation, either version 3 of the License, or

+ *     (at your option) any later version.

+ * b) the terms of the Apache License

+ *

+ * You should have received a copy of both licenses in LICENCE.LGPL and

+ * LICENCE.APACHE. Please refer to those files for details.

+ *

+ * JavaParser is distributed in the hope that it will be useful,

+ * but WITHOUT ANY WARRANTY; without even the implied warranty of

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU Lesser General Public License for more details.

+ */

+

+package com.github.javaparser.generator.core.visitor;

+

+import static com.github.javaparser.utils.CodeGenerationUtils.f;

+

+import com.github.javaparser.ast.CompilationUnit;

+import com.github.javaparser.ast.body.MethodDeclaration;

+import com.github.javaparser.ast.stmt.BlockStmt;

+import com.github.javaparser.generator.VisitorGenerator;

+import com.github.javaparser.metamodel.BaseNodeMetaModel;

+import com.github.javaparser.metamodel.JavaParserMetaModel;

+import com.github.javaparser.metamodel.PropertyMetaModel;

+import com.github.javaparser.utils.SourceRoot;

+

+public class NoCommentEqualsVisitorGenerator extends VisitorGenerator {

+

+    public NoCommentEqualsVisitorGenerator(SourceRoot sourceRoot) {

+        super(sourceRoot, "com.github.javaparser.ast.visitor", "NoCommentEqualsVisitor", "Boolean", "Visitable", true);

+    }

+

+    @Override

+    protected void generateVisitMethodBody(BaseNodeMetaModel node, MethodDeclaration visitMethod,

+                                           CompilationUnit compilationUnit) {

+        visitMethod.getParameters().forEach(p -> p.setFinal(true));

+

+        BlockStmt body = visitMethod.getBody().get();

+        body.getStatements().clear();

+

+        if (!(node.equals(JavaParserMetaModel.lineCommentMetaModel)

+                || node.equals(JavaParserMetaModel.blockCommentMetaModel)

+                || node.equals(JavaParserMetaModel.javadocCommentMetaModel))) {

+

+            body.addStatement(f("final %s n2 = (%s) arg;", node.getTypeName(), node.getTypeName()));

+

+            for (PropertyMetaModel field : node.getAllPropertyMetaModels()) {

+                final String getter = field.getGetterMethodName() + "()";

+                if (field.equals(JavaParserMetaModel.nodeMetaModel.commentPropertyMetaModel))

+                    continue;

+                if (field.getNodeReference().isPresent()) {

+                    if (field.isNodeList()) {

+                        body.addStatement(f("if (!nodesEquals(n.%s, n2.%s)) return false;", getter, getter));

+                    } else {

+                        body.addStatement(f("if (!nodeEquals(n.%s, n2.%s)) return false;", getter, getter));

+                    }

+                } else {

+                    body.addStatement(f("if (!objEquals(n.%s, n2.%s)) return false;", getter, getter));

+                }

+            }

+            if (body.getStatements().size() == 1) {

+                // Only the cast line was added, but nothing is using it, so remove it again.

+                body.getStatements().clear();

+            }

+        }

+        body.addStatement("return true;");

+    }

+}
\ No newline at end of file
diff --git a/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/visitor/NoCommentHashCodeVisitorGenerator.java b/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/visitor/NoCommentHashCodeVisitorGenerator.java
new file mode 100644
index 000000000..b36d25934
--- /dev/null
+++ b/javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/visitor/NoCommentHashCodeVisitorGenerator.java
@@ -0,0 +1,89 @@
+/*

+ * Copyright (C) 2007-2010 Júlio Vilmar Gesser.

+ * Copyright (C) 2011, 2013-2016 The JavaParser Team.

+ *

+ * This file is part of JavaParser.

+ *

+ * JavaParser can be used either under the terms of

+ * a) the GNU Lesser General Public License as published by

+ *     the Free Software Foundation, either version 3 of the License, or

+ *     (at your option) any later version.

+ * b) the terms of the Apache License

+ *

+ * You should have received a copy of both licenses in LICENCE.LGPL and

+ * LICENCE.APACHE. Please refer to those files for details.

+ *

+ * JavaParser is distributed in the hope that it will be useful,

+ * but WITHOUT ANY WARRANTY; without even the implied warranty of

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU Lesser General Public License for more details.

+ */

+

+package com.github.javaparser.generator.core.visitor;

+

+import static com.github.javaparser.JavaParser.parseStatement;

+

+import java.util.List;

+

+import com.github.javaparser.ast.CompilationUnit;

+import com.github.javaparser.ast.body.MethodDeclaration;

+import com.github.javaparser.ast.stmt.BlockStmt;

+import com.github.javaparser.generator.VisitorGenerator;

+import com.github.javaparser.metamodel.BaseNodeMetaModel;

+import com.github.javaparser.metamodel.JavaParserMetaModel;

+import com.github.javaparser.metamodel.PropertyMetaModel;

+import com.github.javaparser.utils.SeparatedItemStringBuilder;

+import com.github.javaparser.utils.SourceRoot;

+

+public class NoCommentHashCodeVisitorGenerator extends VisitorGenerator {

+

+    public NoCommentHashCodeVisitorGenerator(SourceRoot sourceRoot) {

+        super(sourceRoot, "com.github.javaparser.ast.visitor", "NoCommentHashCodeVisitor", "Integer", "Void", true);

+    }

+

+    @Override

+    protected void generateVisitMethodBody(BaseNodeMetaModel node, MethodDeclaration visitMethod,

+                                           CompilationUnit compilationUnit) {

+        visitMethod.getParameters().forEach(p -> p.setFinal(true));

+

+        final BlockStmt body = visitMethod.getBody().get();

+        body.getStatements().clear();

+

+        final SeparatedItemStringBuilder builder = new SeparatedItemStringBuilder("return ", "* 31 +", ";");

+        final List<PropertyMetaModel> propertyMetaModels = node.getAllPropertyMetaModels();

+        if (node.equals(JavaParserMetaModel.lineCommentMetaModel)

+                || node.equals(JavaParserMetaModel.blockCommentMetaModel)

+                || node.equals(JavaParserMetaModel.javadocCommentMetaModel) || propertyMetaModels.isEmpty()) {

+            builder.append("0");

+        } else {

+            for (PropertyMetaModel field : propertyMetaModels) {

+                final String getter = field.getGetterMethodName() + "()";

+                if (field.equals(JavaParserMetaModel.nodeMetaModel.commentPropertyMetaModel)) {

+                    if (propertyMetaModels.size() == 1) {

+                        builder.append("0");

+                        break;

+                    } else

+                        continue;

+                }

+                // Is this field another AST node? Visit it.

+                if (field.getNodeReference().isPresent()) {

+                    if (field.isOptional()) {

+                        builder.append("(n.%s.isPresent()? n.%s.get().accept(this, arg):0)", getter, getter);

+                    } else {

+                        builder.append("(n.%s.accept(this, arg))", getter);

+                    }

+                } else {

+                    Class<?> type = field.getType();

+                    if (type.equals(boolean.class)) {

+                        builder.append("(n.%s?1:0)", getter);

+                    } else if (type.equals(int.class)) {

+                        builder.append("n.%s", getter);

+                    } else {

+                        builder.append("(n.%s.hashCode())", getter);

+                    }

+                }

+            }

+        }

+        body.addStatement(parseStatement(builder.toString()));

+    }

+}