/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package selectionresolution;

import java.util.function.BiConsumer;

import java.util.function.Consumer;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.EnumSet;

import java.util.HashSet;

import java.util.LinkedList;

/**

 * Templates are sets of transformations that are applied to a

 * SelectionResolutionTestCase.Builder as part of building up a test

 * case.  Templates should contain a collection of different

 * transforms, all of which represent an "interesting" case in a

 * general category of cases.

 *

 */

public class Template {

    public enum Kind { CLASS, INTERFACE; }

    public final Collection<Consumer<SelectionResolutionTestCase.Builder>> cases;

    public final String name;

    /**

     * Create a template from a collection of lambdas that modify a Builder.

     *

     * @param name The name of the template.

     * @param cases The cases in the template.

     */

    public Template(final String name,

                    final Collection<Consumer<SelectionResolutionTestCase.Builder>> cases) {

        this.cases = cases;

        this.name = name;

    }

    /**

     * Build a template out of a set of lambdas that modify a Builder.

     *

     * @param name The name of the template.

     * @param cases The cases in the template.

     */

    public Template(final String name,

                    final Consumer<SelectionResolutionTestCase.Builder>... cases) {

        this(name, Arrays.asList(cases));

    }

    /**

     * Build a template out of a set of lambdas that modify a Builder.

     * Also include all cases from another template.

     *

     * @param name The name of the template.

     * @param include Include all cases from this template.

     * @param cases The cases in the template.

     */

    public Template(final String name,

                    final Template include,

                    final Consumer<SelectionResolutionTestCase.Builder>... cases) {

        this(name, new LinkedList(include.cases));

        this.cases.addAll(Arrays.asList(cases));

    }

    /**

     * Build a template out of a set of lambdas that modify a Builder.

     * Also include all cases from another template.

     *

     * @param name The name of the template.

     * @param include Include all cases from this template.

     * @param cases The cases in the template.

     */

    public Template(final String name,

                    final Template... others) {

        this(name, new LinkedList());

        for(final Template template : others) {

            cases.addAll(template.cases);

        }

    }

    /**

     * Run all cases in the template.  This will run each action in

     * the template and then call the next action on a separate copy

     * of the builder parameter.

     *

     * @param The next action to perform of the Builder.

     * @param The Builder to modify.

     */

    public void runCases(final Consumer<SelectionResolutionTestCase.Builder> next,

                         final SelectionResolutionTestCase.Builder builder) {

        for(final Consumer<SelectionResolutionTestCase.Builder> thiscase : cases) {

            final SelectionResolutionTestCase.Builder localbuilder = builder.copy();

            thiscase.accept(localbuilder);

            next.accept(localbuilder);

        }

    }

    public void printCases(final SelectionResolutionTestCase.Builder builder) {

        int i = 1;

        System.err.println("Template " + name + ":\n");

        for(final Consumer<SelectionResolutionTestCase.Builder> thiscase : cases) {

            final SelectionResolutionTestCase.Builder localbuilder = builder.copy();

            thiscase.accept(localbuilder);

            System.err.println("Case " + i++);

            System.err.println(localbuilder);

        }

    }

    /* Create an empty class in the given package */

    public static final ClassData emptyClass(final ClassData.Package pck) {

        return new ClassData(pck, null);

    }

    /* These are functions that are used to build callsite templates */

    public static void callsiteIsMethodref(final SelectionResolutionTestCase.Builder builder) {

        builder.callsite = builder.methodref;

    }

    public static void callsiteSubclassMethodref(final SelectionResolutionTestCase.Builder builder) {

        final int callsite =

            builder.addClass(Template.emptyClass(ClassData.Package.SAME));

        builder.hier.addInherit(callsite, builder.methodref);

        builder.callsite = callsite;

    }

    public static void callsiteUnrelatedMethodref(final SelectionResolutionTestCase.Builder builder) {

        final int callsite =

            builder.addClass(Template.emptyClass(ClassData.Package.SAME));

        builder.callsite = callsite;

    }

    public static void methodrefIsExpected(final SelectionResolutionTestCase.Builder builder) {

        builder.methodref = builder.expected;

    }

    public static final Template MethodrefEqualsExpected =

        new Template("MethodrefEqualsExpected",

                     Template::methodrefIsExpected);

    /*****************************

     *    Set Invoke Template    *

     *****************************/

    public static final Template SetInvoke(final SelectionResolutionTestCase.InvokeInstruction invoke) {

        return new Template("SetInvoke(" + invoke + ")",

                            Collections.singleton((builder) -> {

                                    builder.invoke = invoke;

                                }));

    }

    /*****************************

     *   Result Combo Template   *

     *****************************/

    public static Template ResultCombo(final EnumSet<Kind> kinds,

                                       final EnumSet<MethodData.Access> accesses,

                                       final EnumSet<MethodData.Context> contexts,

                                       final EnumSet<ClassData.Package> packages) {

        final LinkedList<Consumer<SelectionResolutionTestCase.Builder>> cases =

            new LinkedList<>();

        for (final Kind kind : kinds) {

            for (final MethodData.Access acc : accesses) {

                for (final MethodData.Context ctx : contexts) {

                    if (!(acc == MethodData.Access.PRIVATE &&

                          ctx == MethodData.Context.ABSTRACT)) {

                        for (final ClassData.Package pck : packages) {

                            cases.add((builder) -> {

                                    final MethodData meth = new MethodData(acc, ctx);

                                    final ClassData cls = new ClassData(pck, meth);

                                    switch(kind) {

                                    case CLASS:

                                        builder.expected = builder.addClass(cls);

                                        break;

                                    case INTERFACE:

                                        builder.expected = builder.addInterface(cls);

                                        break;

                                    }

                                });

                        }

                    }

                }

            }

        }

        return new Template("ResultCombo", cases);

    }

    public static Template ResolutionOverride(final EnumSet<Kind> kinds,

                                              final EnumSet<MethodData.Access> accesses,

                                              final EnumSet<MethodData.Context> contexts,

                                              final EnumSet<ClassData.Package> packages) {

        final LinkedList<Consumer<SelectionResolutionTestCase.Builder>> cases =

            new LinkedList<>();

        for (final Kind kind : kinds) {

            for (final MethodData.Access acc : accesses) {

                for (final MethodData.Context ctx : contexts) {

                    if (!(acc == MethodData.Access.PRIVATE &&

                          ctx == MethodData.Context.ABSTRACT)) {

                        for (final ClassData.Package pck : packages) {

                            cases.add((builder) -> {

                                    final MethodData meth = new MethodData(acc, ctx);

                                    final ClassData cls = new ClassData(pck, meth);

                                    int override = -1;

                                    switch(kind) {

                                    case CLASS:

                                        override = builder.addClass(cls);

                                        break;

                                    case INTERFACE:

                                        override = builder.addInterface(cls);

                                        break;

                                    }

                                    builder.hier.addInherit(override, builder.expected);

                                });

                        }

                    }

                }

            }

        }

        return new Template("ResultCombo", cases);

    }

    /******************************

     *    Resolution Templates    *

     ******************************/

    private static MethodData getMethodData(final MethodData.Access acc,

                                            final MethodData.Context ctx) {

        if (!(acc == MethodData.Access.PUBLIC ||

              acc == MethodData.Access.PLACEHOLDER) &&

            ctx != MethodData.Context.STATIC) {

            return null;

        } else {

            return new MethodData(MethodData.Access.PUBLIC, ctx);

        }

    }

    public static final Template MethodrefNotEqualsExpectedClass =

        new Template("MethodrefNotEqualsExpectedClass",

                     /* Case 1: Inherit from super.

                      *

                      * C2[](res)

                      * C1[C2]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final int C2 = builder.expected;

                         final int C1 = builder.addClass(emptyClass(ClassData.Package.SAME));

                         builder.hier.addInherit(C1, C2);

                         builder.methodref = C1;

                     },

                     /* Case 2: Inherit from super.

                      *

                      * C2[](res), I[](def)

                      * C1[C2,I]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final ClassData withDef = new ClassData(pck, mdata);

                         final int C2 = builder.expected;

                         final int C1 = builder.addClass(emptyClass(ClassData.Package.SAME));

                         final int I = builder.addInterface(withDef);

                         builder.hier.addInherit(C1, C2);

                         builder.hier.addInherit(C1, I);

                         builder.methodref = C1;

                     },

                     /* Case 3: Inherit from super's super.

                      *

                      * C3[](res)

                      * C2[](), I[](def)

                      * C1[C2,I]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final ClassData withDef = new ClassData(pck, mdata);

                         final int C3 = builder.expected;

                         final int C2 = builder.addClass(emptyClass(pck));

                         final int C1 = builder.addClass(emptyClass(ClassData.Package.SAME));

                         final int I = builder.addInterface(withDef);

                         builder.hier.addInherit(C2, C3);

                         builder.hier.addInherit(C1, C2);

                         builder.hier.addInherit(C1, I);

                         builder.methodref = C1;

                     });

    public static final Template IfaceMethodrefNotEqualsExpected =

        new Template("IfaceMethodrefNotEqualsExpected",

                     /* Case 1: Inherit from super.

                      *

                      * I2[](res)

                      * I1[I2]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final int I2 = builder.expected;

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.methodref = I1;

                     },

                     /* Case 2: Inherit from super, skip private.

                      *

                      * I2[](res)

                      * I2[I3](priv)

                      * I1[I2]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData meth =

                             new MethodData(MethodData.Access.PRIVATE,

                                            MethodData.Context.INSTANCE);

                         final ClassData withPrivDef = new ClassData(pck, meth);

                         final int I3 = builder.expected;

                         final int I2 = builder.addInterface(withPrivDef);

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I2, I3);

                         builder.methodref = I1;

                     },

                     /* Case 3: Inherit from super, skip static.

                      *

                      * I2[](res)

                      * I2[I3](stat)

                      * I1[I2]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData meth =

                             new MethodData(MethodData.Access.PUBLIC,

                                            MethodData.Context.STATIC);

                         final ClassData withStatDef = new ClassData(pck, meth);

                         final int I3 = builder.expected;

                         final int I2 = builder.addInterface(withStatDef);

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I2, I3);

                         builder.methodref = I1;

                     },

                     /* Case 4: Maximally-specific.

                      *

                      * I3[](def)

                      * I2[I3](res)

                      * I1[I2]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final ClassData withDef = new ClassData(pck, mdata);

                         final int I3 = builder.addInterface(withDef);

                         final int I2 = builder.expected;

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I2, I3);

                         builder.methodref = I1;

                     },

                     /* Case 5: Diamond, expected at top.

                      *

                      * I4[](res)

                      * I2[I4](), I3[I4]()

                      * I1[I2,I3]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final int I4 = builder.expected;

                         final int I3 = builder.addInterface(emptyClass(pck));

                         final int I2 = builder.addInterface(emptyClass(pck));

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I1, I3);

                         builder.hier.addInherit(I2, I4);

                         builder.hier.addInherit(I3, I4);

                         builder.methodref = I1;

                     },

                     /* Case 6: Diamond, skip private.

                      *

                      * I4[](res)

                      * I2[I4](priv), I3[I4]()

                      * I1[I2,I3]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final MethodData meth =

                             new MethodData(MethodData.Access.PRIVATE,

                                            MethodData.Context.INSTANCE);

                         final ClassData withPrivDef = new ClassData(pck, meth);

                         final int I4 = builder.expected;

                         final int I3 = builder.addInterface(emptyClass(pck));

                         final int I2 = builder.addInterface(withPrivDef);

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I1, I3);

                         builder.hier.addInherit(I2, I4);

                         builder.hier.addInherit(I3, I4);

                         builder.methodref = I1;

                     },

                     /* Case 7: Diamond, skip static.

                      *

                      * I4[](res)

                      * I2[I4](stat), I3[I4]()

                      * I1[I2,I3]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final MethodData meth =

                             new MethodData(MethodData.Access.PUBLIC,

                                            MethodData.Context.STATIC);

                         final ClassData withStatDef = new ClassData(pck, meth);

                         final int I4 = builder.expected;

                         final int I3 = builder.addInterface(emptyClass(pck));

                         final int I2 = builder.addInterface(withStatDef);

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I1, I3);

                         builder.hier.addInherit(I2, I4);

                         builder.hier.addInherit(I3, I4);

                         builder.methodref = I1;

                     },

                     /* Case 8: Diamond, maximally-specific.

                      *

                      * I4[](def)

                      * I2[I4](res), I3[I4]()

                      * I1[I2,I3]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final ClassData withDef = new ClassData(pck, mdata);

                         final int I4 = builder.addInterface(withDef);

                         final int I3 = builder.addInterface(emptyClass(pck));

                         final int I2 = builder.expected;

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I1, I3);

                         builder.hier.addInherit(I2, I4);

                         builder.hier.addInherit(I3, I4);

                         builder.methodref = I1;

                     },

                     /* Case 9: Diamond, maximally-specific, skipping private.

                      *

                      * I4[](def)

                      * I2[I4](res), I3[I4](priv)

                      * I1[I2,I3]() = mref

                      */

                     (final SelectionResolutionTestCase.Builder builder) -> {

                         final ClassData.Package pck =

                             builder.classdata.get(builder.expected).packageId;

                         final MethodData.Context ctx =

                             builder.classdata.get(builder.expected).methoddata.context;

                         final MethodData.Access acc =

                             builder.classdata.get(builder.expected).methoddata.access;

                         final MethodData mdata = getMethodData(acc, ctx);

                         final ClassData withDef = new ClassData(pck, mdata);

                         final MethodData meth =

                             new MethodData(MethodData.Access.PRIVATE,

                                            MethodData.Context.INSTANCE);

                         final ClassData withPrivDef = new ClassData(pck, meth);

                         final int I4 = builder.addInterface(withDef);

                         final int I3 = builder.addInterface(withPrivDef);

                         final int I2 = builder.expected;

                         final int I1 = builder.addInterface(emptyClass(pck));

                         builder.hier.addInherit(I1, I2);

                         builder.hier.addInherit(I1, I3);

                         builder.hier.addInherit(I2, I4);

                         builder.hier.addInherit(I3, I4);

                         builder.methodref = I1;

                     },

                     /* Case 10: Diamond, maximally-specific, skipping static.

                      *