/*

 * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.

 * 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 vm.runtime.defmeth;

import nsk.share.test.TestBase;

import vm.runtime.defmeth.shared.DefMethTest;

import vm.runtime.defmeth.shared.annotation.Crash;

import vm.runtime.defmeth.shared.annotation.KnownFailure;

import vm.runtime.defmeth.shared.annotation.NotApplicableFor;

import vm.runtime.defmeth.shared.data.*;

import static vm.runtime.defmeth.shared.data.method.body.CallMethod.Invoke.*;

import static vm.runtime.defmeth.shared.data.method.body.CallMethod.IndexbyteOp.*;

import vm.runtime.defmeth.shared.builder.TestBuilder;

import static vm.runtime.defmeth.shared.ExecutionMode.*;

/**

 * Scenarios on private methods in interfaces.

 */

public class PrivateMethodsTest extends DefMethTest {

    public static void main(String[] args) {

        TestBase.runTest(new PrivateMethodsTest(), args);

    }

    // invokevirtual & invokeinterface from same/subintf

    // Spec change July 2013 to not allow invokevirtual or invokeinterface

    // to even see an interface private method

    // Throw ICCE if method resolution returns interface private method

    /*

     * testPrivateInvokeVirtual

     *

     * interface I {

     *   default public  int m()        { return (I)this.privateM(); } // invokevirtual

     * }

     * class C implements I {}

     *

     * TEST: I o = new C(); o.m()I throws VerifyError

     * TEST: C o = new C(); o.m()I throws VerifyError

     */

    @NotApplicableFor(modes = { REDEFINITION }) // Can't redefine a class that gets error during loading

    public void testPrivateInvokeVirtual() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("privateM", "()I")

                    .private_().returns(1).build()

                // force an invokevirtual of an IMR to test verification code

                .defaultMethod("m", "()I")

                    .invoke(VIRTUAL, b.intfByName("I"), null, "privateM", "()I", INTERFACEMETHODREF).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I).build();

        b.test().callSite(I, C, "m", "()I").throws_(VerifyError.class).done()

         .test().callSite(C, C, "m", "()I").throws_(VerifyError.class).done()

        .run();

    }

    /*

     * testPrivateInvokeIntf

     *

     * interface I {

     *   default public  int m()        { return (I)this.privateM(); } // invokeinterface

     * }

     * class C implements I {}

     *

     */

    public void testPrivateInvokeIntf() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("privateM", "()I")

                    .private_().returns(1).build()

                .defaultMethod("m", "()I")

                    .invoke(INTERFACE, b.intfByName("I"), null, "privateM", "()I", CALLSITE).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I).build();

        .run();

    }

    /*

     * testPrivateInvokeStatic

     *

     * interface I {

     *   default public  int m()        { return I.privateM(); } // invokestatic

     * }

     * class C implements I {}

     *

     */

    public void testPrivateInvokeStatic() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("privateM", "()I")

                    .private_().returns(1).build()

                .defaultMethod("m", "()I")

                    .invoke(STATIC, b.intfByName("I"), null, "privateM", "()I", CALLSITE).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I).build();

        .run();

    }

    // call from another default method in the same interface

    /*

     * testPrivateCallSameClass

     *

     * interface I {

     * }

     * class C implements I {}

     *

     * TEST: { I o = new C(); o.m()I  == 1; }

     * TEST: { C o = new C(); o.m()I  == 1; }

     */

    public void testPrivateCallSameClass() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("privateM", "()I")

                    .private_().returns(1).build()

                .defaultMethod("m", "()I")

                    .invokeSpecial(b.intfByName("I"), "privateM", "()I").build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I).build();

        b.test().callSite(I, C, "m", "()I").returns(1).done()

         .test().callSite(C, C, "m", "()I").returns(1).done()

        .run();

    }

    /*

     * testPrivateCallSubIntf

     *

     * Attempt to call from subinterface fails

     * interface I {

     * }

     * J, K, L use invokespecial

     * interface J extends I {

     *   default public int m() { return I.super.privateM(); }

     * }

     * interface K extends I {

     *   default public int m() { return K.super.privateM(); }

     * }

     * interface L extends J {

     *   default public int m() { return I.super.privateM(); }

     * }

     * class C implements J {}

     * class D implements K {}

     * class E implements L {}

     *

     * TEST: { J o = new C(); o.m()I throws IAE; }

     * TEST: { C o = new C(); o.m()I throws IAE; }

     * TEST: { K o = new D(); o.m()I throws NSME; } // does not see

     * TEST: { D o = new D(); o.m()I throws NSME; }

     * TEST: { L o = new E(); o.m()I throws VerifyError; } // VerifyError intfmethodref

     * TEST: { E o = new E(); o.m()I throws VerifyError; }

     */

    @NotApplicableFor(modes = { REDEFINITION }) // Can't redefine a class that gets error during loading

    public void testPrivateCallSubIntf() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("privateM", "()I")

                    .private_().returns(1).build()

            .build();

        Interface J = b.intf("J").extend(I)

                .defaultMethod("m", "()I")

                    .invokeSpecial(I, "privateM", "()I").build()

            .build();

        Interface K = b.intf("K").extend(J)

                .defaultMethod("m", "()I")

                    .invokeSpecial(b.intfByName("K"), "privateM", "()I").build()

            .build();

        // L.privateM -> J -> L (I.privateM call)

        Interface L = b.intf("L").extend(J)

                .defaultMethod("m", "()I")

                    .invokeSpecial(I, "privateM", "()I").build()

            .build();

        ConcreteClass C = b.clazz("C").implement(J).build();

        ConcreteClass D = b.clazz("D").implement(K).build();

        ConcreteClass E = b.clazz("E").implement(L).build();

        b.test().callSite(J, C, "m", "()I").throws_(IllegalAccessError.class).done()

         .test().callSite(C, C, "m", "()I").throws_(IllegalAccessError.class).done()

         .test().callSite(K, D, "m", "()I").throws_(NoSuchMethodError.class).done()

         .test().callSite(D, D, "m", "()I").throws_(NoSuchMethodError.class).done()

         .test().callSite(L, E, "m", "()I").throws_(VerifyError.class).done()

         .test().callSite(E, E, "m", "()I").throws_(VerifyError.class).done()

        .run();

    }

    /*

     * Attempt to call from subclass fails

     *

     * interface I {

     * }

     * class C implements I {

     *   public int m() { return I.super.privateM(); }

     * }

     * class D extends C {

     *   public int m() { return I.super.privateM(); }

     * }

     * class E extends C {

     *   public int m() { return C.super.privateM(); }

     * }

     *

     */

    @NotApplicableFor(modes = { REDEFINITION }) // Can't redefine a class that gets error during loading

    public void testPrivateCallImplClass() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("privateM", "()I")

                    .private_().returns(1).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I)

                .concreteMethod("m", "()I")

                    .invokeSpecial(I, "privateM", "()I").build()

            .build();

        ConcreteClass D = b.clazz("D").extend(C)

                .concreteMethod("m", "()I")

                    .invokeSpecial(I, "privateM", "()I").build()

            .build();

        ConcreteClass E = b.clazz("E").extend(C)

                .concreteMethod("m", "()I")

                    .invokeSpecial(C, "privateM", "()I").build()

            .build();

        Class eeExpectedClass;

        if (factory.getVer() >= 52) {

            eeExpectedClass = NoSuchMethodError.class;

        } else {

            // The test gets a VerifyError in this case due to an

            // invokespecial IMR bytecode.  This was not allowed

            // until class file version 52.  (See 8030249.)

            eeExpectedClass = VerifyError.class;

        }

         .test().callSite(E, E, "m", "()I").throws_(eeExpectedClass).done()

        .run();

    }

    // doesn't participate in default method analysis

    //   method overriding

    /*

     *

     * interface I {

     * }

     * class C implements I {}

     *

     * TEST: { I o = new C(); o.m()I throws IllegalAccessError; }

     *                 -mode reflect throws NoSuchMethodException

     */

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("m", "()I")

                    .private_().returns(1).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I).build();

        Class expectedClass;

        if (factory.getExecutionMode().equals("REFLECTION")) {

            expectedClass = NoSuchMethodException.class;

        } else {

            expectedClass = IllegalAccessError.class;

        }

        b.test().callSite(I, C, "m", "()I").throws_(expectedClass).done()

         .test().callSite(C, C, "m", "()I").throws_(NoSuchMethodError.class).done()

        .run();

    }

    /*

     *

     * interface I {

     * }

     * class C implements I {

     *   public int m() { return 2; }

     * }

     *

     * TEST: { I o = new C(); o.m()I  == IllegalAccessError; }

     *                 -mode reflect throws NoSuchMethodException

     * TEST: { C o = new C(); o.m()I  == 2; }

     */

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("m", "()I")

                    .private_().returns(1).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(I)

                .concreteMethod("m", "()I").returns(2).build()

            .build();

        Class expectedClass;

        if (factory.getExecutionMode().equals("REFLECTION")) {

            expectedClass = NoSuchMethodException.class;

        } else {

            expectedClass = IllegalAccessError.class;

        }

        b.test().callSite(I, C, "m", "()I").throws_(expectedClass).done()

         .test().callSite(C, C, "m", "()I").returns(2).done()

        .run();

    }

    /*

     * testPublicOverridePrivate

     *

     * interface I {

     * }

     * interface J extends I {

     *   default public int m() { return 2; }

     * }

     * class C implements J {}

     *

     * TEST: { I o = new C(); o.m()I throws IllegalAccessError; }

     *                 -mode reflect throws NoSuchMethodException

     * TEST: { J o = new C(); o.m()I  == 2; }

     * TEST: { C o = new C(); o.m()I  == 2; }

     */

    public void testPublicOverridePrivate() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("m", "()I")

                    .private_().returns(1).build()

            .build();

        Interface J = b.intf("J").extend(I)

                .defaultMethod("m", "()I")

                    .returns(2).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(J).build();

        Class expectedClass;

        if (factory.getExecutionMode().equals("REFLECTION")) {

            expectedClass = NoSuchMethodException.class;

        } else {

            expectedClass = IllegalAccessError.class;

        }

        b.test().callSite(I, C, "m", "()I").throws_(expectedClass).done()

         .test().callSite(J, C, "m", "()I").returns(2).done()

         .test().callSite(C, C, "m", "()I").returns(2).done()

        .run();

    }

    /*

     * testPrivateOverrideDefault

     *

     * interface I {

     *   default public int m() { return 1; }

     * }

     * interface J extends I {

     * }

     * class C implements J {}

     *

     * TEST: { I o = new C(); o.m()I  == 1; }

     * TEST: { J o = new C(); o.m()I  == IllegalAccessError; } II J.m priv

     * TEST: { C o = new C(); o.m()I  == 1; }

     */

    public void testPrivateOverrideDefault() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("m", "()I")

                    .returns(1).build()

            .build();

        Interface J = b.intf("J").extend(I)

                .defaultMethod("m", "()I")

                    .private_().returns(2).build()

            .build();

        ConcreteClass C = b.clazz("C").implement(J).build();

        b.test().callSite(I, C, "m", "()I").returns(1).done()

         .test().privateCallSite(J, C, "m", "()I").throws_(IllegalAccessError.class).done()

         .test().callSite(C, C, "m", "()I").returns(1).done()

        .run();

    }

    /*

     * testPrivateReabstract

     *

     * interface I {

     * }

     * interface J extends I {

     *   abstract public int m();

     * }

     * class C implements J {}

     *

     * TEST: { I o = new C(); o.m()I throws IllegalAccessError; } II I.m

     *                 -mode reflect throws NoSuchMethodException

     * TEST: { J o = new C(); o.m()I throws java/lang/AbstractMethodError; }

     * TEST: { C o = new C(); o.m()I throws java/lang/AbstractMethodError; }

     */

    public void testPrivateReabstract() {

        TestBuilder b = factory.getBuilder();

        Interface I = b.intf("I")

                .defaultMethod("m", "()I")

                    .private_().returns(1).build()

            .build();

        Interface J = b.intf("J").extend(I)

                .abstractMethod("m", "()I").build()

            .build();

        ConcreteClass C = b.clazz("C").implement(J).build();

        Class expectedClass;

        if (factory.getExecutionMode().equals("REFLECTION")) {

            expectedClass = NoSuchMethodException.class;

        } else {

            expectedClass = IllegalAccessError.class;

        }