/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.codehaus.groovy.classgen;

import org.apache.groovy.ast.tools.AnnotatedNodeUtils;
import org.apache.groovy.ast.tools.ClassNodeUtils;
import org.apache.groovy.ast.tools.MethodNodeUtils;
import org.codehaus.groovy.ast.ASTNode;
import org.codehaus.groovy.ast.ClassCodeVisitorSupport;
import org.codehaus.groovy.ast.ClassHelper;
import org.codehaus.groovy.ast.ClassNode;
import org.codehaus.groovy.ast.ConstructorNode;
import org.codehaus.groovy.ast.FieldNode;
import org.codehaus.groovy.ast.InnerClassNode;
import org.codehaus.groovy.ast.MethodNode;
import org.codehaus.groovy.ast.Parameter;
import org.codehaus.groovy.ast.PropertyNode;
import org.codehaus.groovy.ast.Variable;
import org.codehaus.groovy.ast.expr.BinaryExpression;
import org.codehaus.groovy.ast.expr.ConstantExpression;
import org.codehaus.groovy.ast.expr.DeclarationExpression;
import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.expr.GStringExpression;
import org.codehaus.groovy.ast.expr.MapEntryExpression;
import org.codehaus.groovy.ast.expr.MethodCallExpression;
import org.codehaus.groovy.ast.expr.PropertyExpression;
import org.codehaus.groovy.ast.expr.TupleExpression;
import org.codehaus.groovy.ast.expr.VariableExpression;
import org.codehaus.groovy.ast.stmt.CatchStatement;
import org.codehaus.groovy.ast.stmt.ForStatement;
import org.codehaus.groovy.ast.tools.GeneralUtils;
import org.codehaus.groovy.ast.tools.ParameterUtils;
import org.codehaus.groovy.control.SourceUnit;
import org.codehaus.groovy.syntax.Types;
import org.codehaus.groovy.transform.trait.Traits;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Stream;

import static java.lang.reflect.Modifier.isAbstract;
import static java.lang.reflect.Modifier.isFinal;
import static java.lang.reflect.Modifier.isInterface;
import static java.lang.reflect.Modifier.isNative;
import static java.lang.reflect.Modifier.isPrivate;
import static java.lang.reflect.Modifier.isProtected;
import static java.lang.reflect.Modifier.isPublic;
import static java.lang.reflect.Modifier.isStatic;
import static java.lang.reflect.Modifier.isStrict;
import static java.lang.reflect.Modifier.isSynchronized;
import static java.lang.reflect.Modifier.isTransient;
import static java.lang.reflect.Modifier.isVolatile;
import static java.util.stream.Collectors.joining;
import static org.codehaus.groovy.ast.tools.GenericsUtils.addMethodGenerics;
import static org.codehaus.groovy.ast.tools.GenericsUtils.buildWildcardType;
import static org.codehaus.groovy.ast.tools.GenericsUtils.correctToGenericsSpecRecurse;
import static org.codehaus.groovy.ast.tools.GenericsUtils.createGenericsSpec;
import static org.codehaus.groovy.transform.sc.StaticCompilationVisitor.isStaticallyCompiled;
import static org.objectweb.asm.Opcodes.ACC_FINAL;
import static org.objectweb.asm.Opcodes.ACC_PRIVATE;
import static org.objectweb.asm.Opcodes.ACC_STATIC;
import static org.objectweb.asm.Opcodes.ACC_SYNTHETIC;
import static org.objectweb.asm.Opcodes.ACC_VOLATILE;

/**
 * Checks that a class satisfies various conditions including:
 * <ul>
 *     <li>Incorrect class or method access modifiers</li>
 *     <li>No abstract methods appear in a non-abstract class</li>
 *     <li>Existence and correct visibility for inherited members</li>
 *     <li>Invalid attempts to override final members</li>
 * </ul>
 */
public class ClassCompletionVerifier extends ClassCodeVisitorSupport {

    private static final String[] INVALID_NAME_CHARS = {".", ":", "/", ";", "[", "<", ">"};
    // the groovy.compiler.strictNames system property is experimental and may change default value or be removed in a future version of Groovy
    private final boolean strictNames = Boolean.getBoolean("groovy.compiler.strictNames");
    private boolean inConstructor, inStaticConstructor;
    private final SourceUnit source;
    private ClassNode currentClass;

    /**
     * Creates a new class completion verifier.
     *
     * @param source the source unit to verify
     */
    public ClassCompletionVerifier(final SourceUnit source) {
        this.source = source;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected SourceUnit getSourceUnit() {
        return source;
    }

    /**
     * Returns the class node currently being verified.
     *
     * @return the current class node
     */
    public ClassNode getClassNode() {
        return currentClass;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitClass(final ClassNode node) {
        ClassNode previousClass = currentClass;
        currentClass = node;
        try {
            checkImplementsAndExtends(node);
            if (source != null && !source.getErrorCollector().hasErrors()) {
                checkClassForIncorrectModifiers(node);
                checkInterfaceMethodVisibility(node);
                checkAbstractMethodVisibility(node);
                checkClassForExtendingFinalOrSealed(node);
                checkMethodsForIncorrectName(node);
                checkMethodsForWeakerAccess(node);
                checkMethodsForOverridingFinal(node);
                checkMethodsForOverridingIssue(node);
                checkNoAbstractMethodsNonAbstractClass(node);
                checkClassExtendsOrImplementsSelfTypes(node);
                checkNoStaticMethodWithSameSignatureAsNonStatic(node);
                checkGenericsUsage(node, node.getUnresolvedInterfaces());
                checkGenericsUsage(node, node.getUnresolvedSuperClass());
            }
            super.visitClass(node);
        } finally {
            currentClass = previousClass;
        }
    }

    private void checkNoStaticMethodWithSameSignatureAsNonStatic(final ClassNode node) {
        ClassNode parent = node.getSuperClass();
        Map<String, MethodNode> result;
        // start with methods from the parent if any
        if (parent != null) {
            result = parent.getDeclaredMethodsMap();
        } else {
            result = new HashMap<>();
        }
        // add in unimplemented abstract methods from the interfaces
        ClassNodeUtils.addDeclaredMethodsFromInterfaces(node, result);
        for (MethodNode methodNode : node.getMethods()) {
            MethodNode mn = result.get(methodNode.getTypeDescriptor());
            if (mn != null && (mn.isStatic() ^ methodNode.isStatic()) && !methodNode.isStaticConstructor()) {
                if (!mn.isAbstract()) continue;
                ClassNode declaringClass = mn.getDeclaringClass();
                ClassNode cn = declaringClass.getOuterClass();
                if (cn == null && declaringClass.isResolved()) {
                    // in case of a precompiled class, the outerclass is unknown
                    Class<?> typeClass = declaringClass.getTypeClass();
                    typeClass = typeClass.getEnclosingClass();
                    if (typeClass != null) {
                        cn = ClassHelper.make(typeClass);
                    }
                }
                if (!Traits.isTrait(cn)) {
                    ASTNode errorNode = methodNode;
                    String name = mn.getName();
                    if (errorNode.getLineNumber() == -1) {
                        // try to get a better error message location based on the property
                        for (PropertyNode propertyNode : node.getProperties()) {
                            if (name.startsWith("set") || name.startsWith("get") || name.startsWith("is")) {
                                String propName = Verifier.capitalize(propertyNode.getField().getName());
                                String shortName = name.substring(name.startsWith("is") ? 2 : 3);
                                if (propName.equals(shortName)) {
                                    errorNode = propertyNode;
                                    break;
                                }
                            }
                        }
                    }
                    addError("The " + getDescription(methodNode) + " is already defined in " + getDescription(node) +
                            ". You cannot have both a static and an instance method with the same signature", errorNode);
                }
            }
            result.put(methodNode.getTypeDescriptor(), methodNode);
        }
    }

    private void checkInterfaceMethodVisibility(final ClassNode node) {
        if (!node.isInterface()) return;
        for (MethodNode method : node.getMethods()) {
            if (!method.isPublic()) {
                if (method.isAbstract()) {
                    addError("The method '" + method.getName() + "' must be public as it is declared abstract in " + getDescription(node) + ".", method);
                } else if (!method.isPrivate() && !method.isStaticConstructor()) {
                    // normal parsing blocks non-static protected or @PackageScope
                    addError("The method '" + method.getName() + "' is " + (method.isProtected() ? "protected" : "package-private") +
                            " but must be " + (method.isStatic() ? "public" : "default") + " or private in " + getDescription(node) + ".", method);
                }
            }
        }
    }

    private void checkAbstractMethodVisibility(final ClassNode node) {
        // we only do check abstract classes (including enums), no interfaces or non-abstract classes
        if (!node.isAbstract() || node.isInterface()) return;
        for (MethodNode method : node.getAbstractMethods()) {
            if (method.isPrivate()) {
                addError("The method '" + method.getName() + "' must not be private as it is declared abstract in " + getDescription(node) + ".", method);
            }
        }
    }

    private void checkNoAbstractMethodsNonAbstractClass(final ClassNode node) {
        if (node.isAbstract()) return;
        for (MethodNode method : node.getAbstractMethods()) {
            MethodNode sameArgsMethod = node.getMethod(method.getName(), method.getParameters());

            String what; ASTNode where = node;
            if (sameArgsMethod == null || sameArgsMethod.getReturnType().equals(method.getReturnType())) {
                what = "Can't have an abstract method in a non-abstract class." +
                        " The " + getDescription(node) + " must be declared abstract or" +
                        " the " + getDescription(method) + " must be implemented.";
            } else {
                what = "Abstract " + getDescription(method) + " is not implemented but a " +
                        "method of the same name but different return type is defined: " +
                        (sameArgsMethod.isStatic() ? "static " : "") + getDescription(sameArgsMethod);
                where = method;
            }
            addError(what, where);
        }
    }

    private void checkClassExtendsOrImplementsSelfTypes(final ClassNode node) {
        if (node.isInterface()) return;
        for (ClassNode anInterface : GeneralUtils.getInterfacesAndSuperInterfaces(node)) {
            if (Traits.isTrait(anInterface)) {
                for (ClassNode selfType : Traits.collectSelfTypes(anInterface, new LinkedHashSet<>(), true, false)) {
                    ClassNode superClass;
                    if (selfType.isInterface() ? !node.implementsInterface(selfType) : !(node.isDerivedFrom(selfType)
                            || ((superClass = node.getNodeMetaData("super.class")) != null && superClass.isDerivedFrom(selfType)))) {
                        addError(getDescription(node) + " implements " + getDescription(anInterface) + " but does not " +
                            (selfType.isInterface() ? "implement" : "extend") + " self type " + getDescription(selfType), anInterface);
                    }
                }
            }
        }
    }

    private void checkClassForIncorrectModifiers(final ClassNode node) {
        if (node.isAbstract() && isFinal(node.getModifiers())) {
            addError("The " + getDescription(node) + " cannot be " + (node.isInterface() ? "final. It is by nature abstract" : "both abstract and final") + ".", node);
        }

        List<String> modifiers = new ArrayList<>();

        if (!(node instanceof InnerClassNode)) {
            if (isProtected(node.getModifiers())) modifiers.add("protected");
            if (isPrivate(node.getModifiers())) modifiers.add("private");
            if (isStatic(node.getModifiers())) modifiers.add("static");
        }
        // do not check for synchronized here; it overlaps with ACC_SUPER
        if (isTransient(node.getModifiers())) modifiers.add("transient");
        if (isVolatile(node.getModifiers())) modifiers.add("volatile");
        if (isNative(node.getModifiers())) modifiers.add("native");

        for (String modifier : modifiers) {
            addError("The " + getDescription(node) + " has invalid modifier " + modifier + ".", node);
        }
    }

    private static String getDescription(final ClassNode node) {
        String kind = (node.isInterface() ? (Traits.isTrait(node) ? "trait" : "interface") : (node.isEnum() ? "enum" : "class"));
        return kind + " '" + node.getName() + "'";
    }

    private static String getDescription(final ConstructorNode node) {
        String name = node.getDeclaringClass().getNameWithoutPackage();
        String spec = Stream.of(node.getParameters()).map(p -> ClassNodeUtils.formatTypeName(p.getType())).collect(joining(", ", "(", ")"));
        return "constructor '" + name + spec + "'";
    }

    private static String getDescription(final MethodNode node) {
        return "method '" + MethodNodeUtils.methodDescriptor(node, true) + "'";
    }

    private static String getDescription(final FieldNode node) {
        return "field '" + node.getName() + "'";
    }

    private static String getDescription(final PropertyNode node) {
        return "property '" + node.getName() + "'";
    }

    private static String getDescription(final Parameter node) {
        return "parameter '" + node.getName() + "'";
    }

    private void checkAbstractDeclaration(final MethodNode methodNode) {
        if (!methodNode.isAbstract() || currentClass.isAbstract() || methodNode.isDefault()) return;

        addError("Can't have an abstract method in a non-abstract class." +
                " The " + getDescription(currentClass) + " must be declared abstract or the method '" +
                MethodNodeUtils.methodDescriptor(methodNode, true) + "' must not be abstract.", methodNode);
    }

    private void checkClassForExtendingFinalOrSealed(final ClassNode cn) {
        boolean isFinal = isFinal(cn.getModifiers());
        boolean isSealed = AnnotatedNodeUtils.hasAnnotation(cn, ClassHelper.SEALED_TYPE);
        boolean isNonSealed = AnnotatedNodeUtils.hasAnnotation(cn, new ClassNode(groovy.transform.NonSealed.class)); // GROOVY-11768

        ClassNode sc = cn.getSuperClass();
        if (sc != null && isFinal(sc.getModifiers())) {
            addError("You are not allowed to extend the final " + getDescription(sc) + ".", cn);
        }

        if (isFinal && isNonSealed) {
            addError("The " + getDescription(cn) + " cannot be both final and non-sealed.", cn);
        }
        if (isSealed) {
            if (isFinal) {
                addError("The " + getDescription(cn) + " cannot be both final and sealed.", cn);
            }
            if (isNonSealed) {
                addError("The " + getDescription(cn) + " cannot be both sealed and non-sealed.", cn);
            }
            if (cn.getPermittedSubclasses().isEmpty()) {
                addError("Sealed " + getDescription(cn) + " has no explicit or implicit permitted subclasses.", cn);
            }
        }

        boolean sealedSuper = sc != null && sc.isSealed();
        boolean nonSealedSuper = sc != null && ClassNodeUtils.isNonSealed(sc);
        boolean sealedInterface = Stream.of(cn.getInterfaces()).anyMatch(ClassNode::isSealed);
        boolean nonSealedInterface = Stream.of(cn.getInterfaces()).anyMatch(ClassNodeUtils::isNonSealed);

        if (isNonSealed && !(sealedSuper || sealedInterface || nonSealedSuper || nonSealedInterface)) {
            addError("The " + getDescription(cn) + " cannot be non-sealed as it has no sealed parent.", cn);
        }
        if (sealedSuper) {
            checkSealedParent(cn, sc);
        }
        if (sealedInterface) {
            for (ClassNode si : cn.getInterfaces()) {
                if (si.isSealed()) {
                    checkSealedParent(cn, si);
                }
            }
        }
    }

    private void checkSealedParent(final ClassNode cn, final ClassNode parent) {
        boolean found = false;
        for (ClassNode permitted : parent.getPermittedSubclasses()) {
            if (permitted.equals(cn)) {
                found = true;
                break;
            }
        }
        if (!found) {
            addError("The " + getDescription(cn) + " is not a permitted subclass of the sealed " + getDescription(parent) + ".", cn);
        }
    }

    private void checkImplementsAndExtends(final ClassNode node) {
        if (!node.isInterface()) {
            ClassNode type = node.getUnresolvedSuperClass();
            if (type != null && type.isInterface()) {
                addError("You are not allowed to extend the " + getDescription(type) + ", use implements instead.", node);
            }
        }
        for (ClassNode type : node.getInterfaces()) {
            if (!type.isInterface()) {
                addError("You are not allowed to implement the " + getDescription(type) + ", use extends instead.", node);
            } else if (type.isSealed()) {
                checkSealedParent(node, type);
            }
        }
    }

    private void checkMethodsForIncorrectName(final ClassNode cn) {
        if (!strictNames) return;
        List<MethodNode> methods = cn.getAllDeclaredMethods();
        for (MethodNode mNode : methods) {
            if (mNode.isConstructor() || mNode.isStaticConstructor()) continue;
            String name = mNode.getName();
            // Groovy allows more characters than Character.isValidJavaIdentifier() would allow
            // if we find a good way to encode special chars we could remove (some of) these checks
            for (String ch : INVALID_NAME_CHARS) {
                if (name.contains(ch)) {
                    addError("You are not allowed to have '" + ch + "' in a method name", mNode);
                }
            }
        }
    }

    private void checkMethodsForWeakerAccess(final ClassNode cn) {
        for (MethodNode cnMethod : cn.getMethods()) {
            if (!cnMethod.isPublic() && !cnMethod.isStatic()) {
            sc: for (MethodNode scMethod : cn.getSuperClass().getMethods(cnMethod.getName())) {
                    if (!scMethod.isStatic()
                            && !scMethod.isPrivate()
                            && (cnMethod.isPrivate()
                            || (cnMethod.isProtected() && scMethod.isPublic())
                            || (cnMethod.isPackageScope() && (scMethod.isPublic() || scMethod.isProtected())))) {
                        if (ParameterUtils.parametersEqual(cnMethod.getParameters(), scMethod.getParameters())) {
                            addWeakerAccessError(cn, cnMethod, scMethod);
                            break sc;
                        }
                    }
                }
            }
        }

        // Verifier: checks weaker access of cn's methods against abstract or default interface methods

        // GROOVY-11758, GROOVY-11830: check for non-public super class method that hides public method
        Map<String, MethodNode> interfaceMethods = ClassNodeUtils.getDeclaredMethodsFromInterfaces(cn);
        if (!interfaceMethods.isEmpty()) {
            for (MethodNode cnMethod : cn.getMethods()) {
                if (!cnMethod.isPrivate() && !cnMethod.isStatic()) {
                    interfaceMethods.remove(cnMethod.getTypeDescriptor());
                }
            }
            for (MethodNode publicMethod : interfaceMethods.values()) {
                for (MethodNode scMethod : cn.getSuperClass().getMethods(publicMethod.getName())) {
                    if (!scMethod.isPublic() && !scMethod.isStatic() && (!scMethod.isPrivate() || !publicMethod.isDefault())
                                && ParameterUtils.parametersEqual(scMethod.getParameters(), publicMethod.getParameters())) {
                        addWeakerAccessError2(cn, scMethod, publicMethod);
                    }
                }
            }
        }
    }

    private void addWeakerAccessError(final ClassNode cn, final MethodNode cnMethod, final MethodNode scMethod) {
        StringBuilder msg = new StringBuilder();
        msg.append(cnMethod.getName());
        appendParamsDescription(cnMethod.getParameters(), msg);
        msg.append(" in ");
        msg.append(cn.getName());
        msg.append(" cannot override ");
        msg.append(scMethod.getName());
        msg.append(" in ");
        msg.append(scMethod.getDeclaringClass().getName());
        msg.append("; attempting to assign weaker access privileges; was ");
        msg.append(scMethod.isPublic() ? "public" : (scMethod.isProtected() ? "protected" : "package-private"));

        addError(msg.toString(), cnMethod);
    }

    private void addWeakerAccessError2(final ClassNode cn, final MethodNode scMethod, final MethodNode ifMethod) {
        StringBuilder msg = new StringBuilder();
        msg.append(scMethod.isPrivate() ? "private" : (scMethod.isProtected() ? "protected" : "package-private"));
        msg.append(" method ");
        msg.append(scMethod.getName());
        appendParamsDescription(scMethod.getParameters(), msg);
        msg.append(" from ");
        msg.append(scMethod.getDeclaringClass().getName());
        msg.append(" cannot shadow the public method in ");
        msg.append(ifMethod.getDeclaringClass().getName());
        addError(msg.toString(), cn);
    }

    private void checkMethodsForOverridingFinal(final ClassNode cn) {
        final int skips = ACC_SYNTHETIC | ACC_STATIC | ACC_PRIVATE;
        for (MethodNode method : cn.getMethods()) {
            if ((method.getModifiers() & skips) != 0) continue; // GROOVY-11579

            Parameter[] params = method.getParameters();
            for (MethodNode superMethod : cn.getSuperClass().getMethods(method.getName())) {
                if ((superMethod.getModifiers() & skips + ACC_FINAL) == ACC_FINAL
                        && ParameterUtils.parametersEqual(params, superMethod.getParameters())) {
                    StringBuilder sb = new StringBuilder();
                    sb.append("You are not allowed to override the final method ");
                    if (method.getName().contains(" ")) {
                        sb.append('"').append(method.getName()).append('"');
                    } else {
                        sb.append(method.getName());
                    }
                    appendParamsDescription(params, sb);
                    sb.append(" from ");
                    sb.append(getDescription(superMethod.getDeclaringClass()));
                    sb.append(".");

                    addError(sb.toString(), method.getLineNumber() > 0 ? method : cn);
                    break;
                }
            }
        }
    }

    private void checkMethodsForOverridingIssue(final ClassNode cn) {
        Set<ClassNode> superTypes = getAllSuperTypes(cn);
        superTypes.remove(ClassHelper.GROOVY_OBJECT_TYPE);
        superTypes.remove(ClassHelper.OBJECT_TYPE);
        if (superTypes.isEmpty()) return;

        for (MethodNode mn : cn.getMethods()) {
            Parameter[] pa = mn.getParameters();
            if (pa.length == 0 || (mn.getModifiers() & ACC_SYNTHETIC + ACC_STATIC + ACC_PRIVATE) != 0) continue;

out:        for (ClassNode sc : superTypes) {
                Map<String, ClassNode> cspec = createGenericsSpec(sc);
                for (MethodNode sm : sc.getDeclaredMethods(mn.getName())) {
                    if (!sm.isStatic() && !sm.isPrivate() && ParameterUtils.parametersEqual(pa, sm.getParameters())) {
                        Map<String, ClassNode> mspec = addMethodGenerics(sm, cspec);
                        for (int i = 0, n = pa.length; i < n; i += 1) {
                            var t0 = sm.getParameters()[i].getType();
                            var t1 = pa[i].getType();
                            if (!t0.isGenericsPlaceHolder() && !ClassHelper.isPrimitiveType(t0)
                                    && !t1.isGenericsPlaceHolder() && !ClassHelper.isPrimitiveType(t1)
                                    && !buildWildcardType(t0 = correctToGenericsSpecRecurse(mspec, t0)).isCompatibleWith(t1)) {
                                StringBuilder sb = new StringBuilder();
                                sb.append("name clash: ");
                                if (mn.getName().contains(" ")) {
                                    sb.append('"').append(mn.getName()).append('"');
                                } else {
                                    sb.append(mn.getName());
                                }
                                appendParamsDescription(pa, sb);
                                sb.append(" in ");
                                sb.append(getDescription(cn));
                                sb.append(" and ");
                                if (sm.getName().contains(" ")) {
                                    sb.append('"').append(sm.getName()).append('"');
                                } else {
                                    sb.append(sm.getName());
                                }
                                appendParamsDescription(sm.getParameters(), sb);
                                sb.append(" in ");
                                sb.append(getDescription(sc));
                                sb.append(" have the same erasure, yet neither overrides the other.");

                                addError(sb.toString(), mn.getLineNumber() > 0 ? mn : cn);
                                break;
                            }
                        }
                        break out;
                    }
                }
            }
        }
    }

    private static Set<ClassNode> getAllSuperTypes(ClassNode cn) {
        Set<ClassNode> interfaces = GeneralUtils.getInterfacesAndSuperInterfaces(cn);
        Set<ClassNode> superTypes = new LinkedHashSet<>();
        interfaces.remove(cn);
        while ((cn = cn.getSuperClass()) != null) {
            superTypes.add(cn);
        }
        superTypes.addAll(interfaces);
        return superTypes;
    }

    private void appendParamsDescription(final Parameter[] parameters, final StringBuilder msg) {
        msg.append('(');
        boolean needsComma = false;
        for (Parameter parameter : parameters) {
            if (needsComma) {
                msg.append(',');
            } else {
                needsComma = true;
            }
            msg.append(parameter.getType().toString(false));
        }
        msg.append(')');
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitMethod(final MethodNode node) {
        inConstructor = false;
        inStaticConstructor = node.isStaticConstructor();
        checkAbstractDeclaration(node);
        if (!inStaticConstructor) {
            checkRepetitiveMethod(node);
            checkOverloadingPrivateAndPublic(node);
        }
        checkMethodForIncorrectModifiers(node);
        checkGenericsUsage(node, node.getReturnType());
        checkGenericsUsage(node, node.getParameters());
        for (Parameter parameter : node.getParameters()) {
            if (ClassHelper.isPrimitiveVoid(parameter.getType())) {
                addError("The " + getDescription(parameter) + " in " +  getDescription(node) + " has invalid type void", parameter);
            }
        }
        super.visitMethod(node);
    }

    private void checkMethodForIncorrectModifiers(final MethodNode node) {
        if (node.isAbstract() && (node.isStatic() || (node.isFinal() && !currentClass.isInterface()))) { // GROOVY-11508
            addError("The " + getDescription(node) + " can only be one of abstract, static, " + (currentClass.isInterface() ? "default" : "final") + ".", node);
        }

        List<String> modifiers = new ArrayList<>();

        if (currentClass.isInterface()) {
            if (isFinal(node.getModifiers())) modifiers.add("final");
            if (isNative(node.getModifiers())) modifiers.add("native");
            if (isStrict(node.getModifiers())) modifiers.add("strictfp");
            if (isSynchronized(node.getModifiers())) modifiers.add("synchronized");
        }
        // transient overlaps with varargs but we do not add varargs until AsmClassGenerator
        // but we might have varargs set from @Delegate of varargs method, so skip generated
        if (!AnnotatedNodeUtils.isGenerated(node)) {
            if (isTransient(node.getModifiers())) modifiers.add("transient");
        }

        for (String modifier : modifiers) {
            addError("The " + getDescription(node) + " has invalid modifier " + modifier + ".", node);
        }
    }

    private void checkOverloadingPrivateAndPublic(final MethodNode node) {
        if (isStaticallyCompiled(currentClass)) return; // GROOVY-11627
        boolean mixed = false;
        if (node.isPublic()) {
            for (MethodNode mn : currentClass.getDeclaredMethods(node.getName())) {
                if (mn != node && !(mn.isPublic() || mn.isProtected())) {
                    mixed = true;
                    break;
                }
            }
        } else if (node.isPrivate()) {
            for (MethodNode mn : currentClass.getDeclaredMethods(node.getName())) {
                if (mn != node && (mn.isPublic() || mn.isProtected())) {
                    mixed = true;
                    break;
                }
            }
        }
        if (mixed) { // GROOVY-5193
            addError("Mixing private and public/protected methods of the same name causes multimethods to be disabled and is forbidden to avoid surprising behaviour. Renaming the private methods will solve the problem.", node);
        }
    }

    private void checkRepetitiveMethod(final MethodNode node) {
        for (MethodNode method : currentClass.getMethods(node.getName())) {
            if (method == node) continue;
            if (!method.getDeclaringClass().equals(node.getDeclaringClass())) continue;
            Parameter[] p1 = node.getParameters();
            Parameter[] p2 = method.getParameters();
            if (p1.length != p2.length) continue;
            addErrorIfParamsAndReturnTypeEqual(p2, p1, node, method);
        }
    }

    private void addErrorIfParamsAndReturnTypeEqual(final Parameter[] p2, final Parameter[] p1, final MethodNode node, final MethodNode element) {
        boolean isEqual = true;
        for (int i = 0; i < p2.length; i++) {
            isEqual &= p1[i].getType().equals(p2[i].getType());
            if (!isEqual) break;
        }
        isEqual &= node.getReturnType().equals(element.getReturnType());
        if (isEqual) {
            addError("Repetitive method name/signature for " + getDescription(node) + " in " + getDescription(currentClass) + ".", node);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitField(final FieldNode node) {
        if (currentClass.getDeclaredField(node.getName()) != node) {
            addError("The " + getDescription(node) + " is declared multiple times.", node);
        }
        checkInterfaceFieldModifiers(node);
        checkInvalidFieldModifiers(node);
        checkGenericsUsage(node, node.getType());
        if (ClassHelper.isPrimitiveVoid(node.getType())) {
            addError("The " + getDescription(node) + " has invalid type void", node);
        }
        super.visitField(node);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitProperty(final PropertyNode node) {
        if (currentClass.getProperty(node.getName()) != node) {
            addError("The " + getDescription(node) + " is declared multiple times.", node);
        }
        checkDuplicateProperties(node);
        checkGenericsUsage(node, node.getType());
        super.visitProperty(node);
    }

    private void checkDuplicateProperties(final PropertyNode node) {
        ClassNode cn = node.getDeclaringClass();
        String name = node.getName();
        String getterName = node.getGetterNameOrDefault();
        if (Character.isUpperCase(name.charAt(0))) {
            for (PropertyNode otherNode : cn.getProperties()) {
                String otherName = otherNode.getName();
                if (node != otherNode && getterName.equals(otherNode.getGetterNameOrDefault())) {
                    String msg = "The field " + name + " and " + otherName + " on the class " +
                            cn.getName() + " will result in duplicate JavaBean properties, which is not allowed";
                    addError(msg, node);
                }
            }
        }
    }

    private void checkInterfaceFieldModifiers(final FieldNode node) {
        if (currentClass.isInterface() && !(node.isPublic() && node.isStatic() && node.isFinal())) {
            addError("The " + getDescription(node) + " is not 'public static final' but is defined in " + getDescription(currentClass) + ".", node);
        }
    }

    private void checkInvalidFieldModifiers(final FieldNode node) {
        if ((node.getModifiers() & (ACC_FINAL | ACC_VOLATILE)) == (ACC_FINAL | ACC_VOLATILE)) {
            addError("Illegal combination of modifiers, final and volatile, for field '" + node.getName() + "'", node);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitBinaryExpression(final BinaryExpression expression) {
        if (expression.getOperation().getType() == Types.LEFT_SQUARE_BRACKET &&
                expression.getRightExpression() instanceof MapEntryExpression) {
            addError("You tried to use a map entry for an index operation, this is not allowed. " +
                    "Maybe something should be set in parentheses or a comma is missing?",
                    expression.getRightExpression());
        }
        super.visitBinaryExpression(expression);

        if (Types.isAssignment(expression.getOperation().getType())) {
            checkFinalFieldAccess(expression.getLeftExpression());
            checkSuperOrThisOnLHS(expression.getLeftExpression());
        }
    }

    private void checkSuperOrThisOnLHS(final Expression expression) {
        if (!(expression instanceof VariableExpression ve)) return;
        if (ve.isThisExpression()) {
            addError("cannot have 'this' as LHS of an assignment", expression);
        } else if (ve.isSuperExpression()) {
            addError("cannot have 'super' as LHS of an assignment", expression);
        }
    }

    private void checkFinalFieldAccess(final Expression expression) {
        if (!(expression instanceof VariableExpression) && !(expression instanceof PropertyExpression)) return;
        Variable v = null;
        if (expression instanceof VariableExpression ve) {
            v = ve.getAccessedVariable();
        } else {
            PropertyExpression propExp = ((PropertyExpression) expression);
            Expression objectExpression = propExp.getObjectExpression();
            if (objectExpression instanceof VariableExpression varExp) {
                if (varExp.isThisExpression()) {
                    v = currentClass.getDeclaredField(propExp.getPropertyAsString());
                }
            }
        }
        if (v instanceof FieldNode fn) {

            /*
             *  if it is static final but not accessed inside a static constructor, or,
             *  if it is an instance final but not accessed inside an instance constructor, it is an error
             */
            boolean isFinal = fn.isFinal();
            boolean isStatic = fn.isStatic();
            boolean error = isFinal && ((isStatic && !inStaticConstructor) || (!isStatic && !inConstructor));

            if (error) addError("cannot modify" + (isStatic ? " static" : "") + " final field '" + fn.getName() +
                    "' outside of " + (isStatic ? "static initialization block." : "constructor."), expression);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitConstructor(final ConstructorNode node) {
        inConstructor = true; inStaticConstructor = false;
        checkGenericsUsage(node, node.getParameters());
        List<String> modifiers = new ArrayList<>();
        int mods = node.getModifiers();

        if (isStatic      (mods)) modifiers.add("static"      );
        if (isFinal       (mods)) modifiers.add("final"       );
        if (isSynchronized(mods)) modifiers.add("synchronized");
        if (isVolatile    (mods)) modifiers.add("volatile"    );
        if (isNative      (mods)) modifiers.add("native"      );
        if (isInterface   (mods)) modifiers.add("interface"   );
        if (isAbstract    (mods)) modifiers.add("abstract"    );
        if (isStrict      (mods)) modifiers.add("strictfp"    );

        for (String modifier : modifiers) {
            addError("The " + getDescription(node) + " has invalid modifier " + modifier + ".", node);
        }

        for (Parameter parameter : node.getParameters()) {
            if (ClassHelper.isPrimitiveVoid(parameter.getType())) {
                addError("The " + getDescription(parameter) + " in " +  getDescription(node) + " has invalid type void", parameter);
            }
        }

        super.visitConstructor(node);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitCatchStatement(final CatchStatement cs) {
        List<String> modifiers = new ArrayList<>();
        int mods = cs.getVariable().getModifiers();

        if (isAbstract (mods)) modifiers.add("abstract" );
        if (isPrivate  (mods)) modifiers.add("private"  );
        if (isProtected(mods)) modifiers.add("protected");
        if (isPublic   (mods)) modifiers.add("public"   );
        if (isStatic   (mods)) modifiers.add("static"   );
        if (isStrict   (mods)) modifiers.add("strictfp" );

        for (String modifier : modifiers) {
            addError("The catch " + getDescription(cs.getVariable()) + " has invalid modifier " + modifier + ".", cs);
        }

        if (!(cs.getExceptionType().isDerivedFrom(ClassHelper.THROWABLE_TYPE))) {
            addError("Catch statement parameter type is not a subclass of Throwable.", cs);
        }

        super.visitCatchStatement(cs);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitForLoop(final ForStatement fs) {
        if (fs.getValueVariable() != null) {
            checkModifiers(fs, fs.getValueVariable());
        }
        super.visitForLoop(fs);
    }

    private void checkModifiers(ForStatement fs, Parameter p) {
        List<String> modifiers = new ArrayList<>();
        int mods = p.getModifiers();
        if (isAbstract (mods)) modifiers.add("abstract" );
        if (isPrivate  (mods)) modifiers.add("private"  );
        if (isProtected(mods)) modifiers.add("protected");
        if (isPublic   (mods)) modifiers.add("public"   );
        if (isStatic   (mods)) modifiers.add("static"   );
        if (isStrict   (mods)) modifiers.add("strictfp" );

        for (String modifier : modifiers) {
            addError("The variable '" + p.getName() + "' has invalid modifier " + modifier + ".", fs);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitMethodCallExpression(final MethodCallExpression mce) {
        super.visitMethodCallExpression(mce);
        Expression aexp = mce.getArguments();
        if (aexp instanceof TupleExpression arguments) {
            for (Expression e : arguments.getExpressions()) {
                checkForInvalidDeclaration(e);
            }
        } else {
            checkForInvalidDeclaration(aexp);
        }
    }

    private void checkForInvalidDeclaration(final Expression exp) {
        if (!(exp instanceof DeclarationExpression)) return;
        addError("Invalid use of declaration inside method call.", exp);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitDeclarationExpression(final DeclarationExpression expression) {
        super.visitDeclarationExpression(expression);

        if (expression.isMultipleAssignmentDeclaration()) return;
        var vexp = expression.getVariableExpression();
        List<String> modifiers = new ArrayList<>();
        int mods = vexp.getModifiers();

        if (isAbstract    (mods)) modifiers.add("abstract"     );
        if (isNative      (mods)) modifiers.add("native"       );
        if (isPrivate     (mods)) modifiers.add("private"      );
        if (isProtected   (mods)) modifiers.add("protected"    );
        if (isPublic      (mods)) modifiers.add("public"       );
        if (isStatic      (mods)) modifiers.add("static"       );
        if (isStrict      (mods)) modifiers.add("strictfp"     );
        if (isSynchronized(mods)) modifiers.add("synchronized" );
        if (isTransient   (mods)) modifiers.add("transient"    );
        if (isVolatile    (mods)) modifiers.add("volatile"     );

        for (String modifier : modifiers) {
            addError("The variable '" + vexp.getName() + "' has invalid modifier " + modifier + ".", expression);
        }

        if (ClassHelper.isPrimitiveVoid(vexp.getOriginType())) {
            addError("The variable '" + vexp.getName() + "' has invalid type void.", expression);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitConstantExpression(final ConstantExpression expression) {
        super.visitConstantExpression(expression);
        checkStringExceedingMaximumLength(expression);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void visitGStringExpression(final GStringExpression expression) {
        super.visitGStringExpression(expression);
        for (ConstantExpression ce : expression.getStrings()) {
            checkStringExceedingMaximumLength(ce);
        }
    }

    private void checkStringExceedingMaximumLength(final ConstantExpression expression) {
        Object value = expression.getValue();
        if (value instanceof String s) {
            if (s.length() > 65535) {
                addError("String too long. The given string is " + s.length() + " Unicode code units long, but only a maximum of 65535 is allowed.", expression);
            }
        }
    }

    private void checkGenericsUsage(final ASTNode ref, final ClassNode[] nodes) {
        for (ClassNode node : nodes) {
            checkGenericsUsage(ref, node);
        }
    }

    private void checkGenericsUsage(final ASTNode ref, final Parameter[] params) {
        for (Parameter p : params) {
            checkGenericsUsage(ref, p.getType());
        }
    }

    private void checkGenericsUsage(final ASTNode ref, final ClassNode node) {
        if (node.isArray()) {
            checkGenericsUsage(ref, node.getComponentType());
        } else if (!node.isRedirectNode() && node.isUsingGenerics()) {
            addError(
                    "A transform used a generics-containing ClassNode "+ node +
                    " for " + getRefDescriptor(ref) +
                    "directly. You are not supposed to do this. " +
                    "Please create a clean ClassNode using ClassNode#getPlainNodeReference() " +
                    "and #setGenericsTypes(GenericsType[]) on it or use GenericsUtils.makeClassSafe* " +
                    "and use the new ClassNode instead of the original one. Otherwise, " +
                    "the compiler will create incorrect descriptors potentially leading to " +
                    "NullPointerExceptions in the TypeResolver class. If this is not your own " +
                    "doing, please report this bug to the writer of the transform.",
                    ref);
        }
    }

    private static String getRefDescriptor(final ASTNode ref) {
        if (ref instanceof FieldNode f) {
            return "the field "+f.getName()+" ";
        } else if (ref instanceof PropertyNode p) {
            return "the property "+p.getName()+" ";
        } else if (ref instanceof ConstructorNode) {
            return "the constructor "+ref.getText()+" ";
        } else if (ref instanceof MethodNode) {
            return "the method "+ref.getText()+" ";
        } else if (ref instanceof ClassNode) {
            return "the super class "+ref+" ";
        }
        return "<unknown with class "+ref.getClass()+"> ";
    }
}
