/*

 * 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 nsk.jdi.ReferenceType.locationsOfLine_ssi;

import nsk.share.*;

import nsk.share.jpda.*;

import nsk.share.jdi.*;

import com.sun.jdi.*;

import java.util.*;

import java.io.*;

/**

 * The test for the implementation of an object of the type     <BR>

 * ReferenceType.                                               <BR>

 *                                                              <BR>

 * The test checks up that results of the method                <BR>

 * <code>com.sun.jdi.ReferenceType.locationsOfLine(String,String,int)</code> <BR>

 * complies with its specification.                             <BR>

 * <BR>

 * The test checks up that for each line in the List returned   <BR>

 * by the method ReferenceType.allLineLocations(),              <BR>

 * the method locationsOfLine(defaultStratum,null,lineNumber)   <BR>

 * returns non-empty List object                                <BR>

 * in which each object is a Location object.<BR>

 * Not throwing AbsentInformationException is checked up as well.<BR>

 */

public class locationsofline_ssi001 {

    //----------------------------------------------------- templete section

    static final int PASSED = 0;

    static final int FAILED = 2;

    static final int PASS_BASE = 95;

    //----------------------------------------------------- templete parameters

    static final String

    sHeader1 = "\n==> nsk/jdi/ReferenceType/locationsOfLine_ssi/locationsofline_ssi001 ",

    sHeader2 = "--> debugger: ",

    sHeader3 = "##> debugger: ";

    //----------------------------------------------------- main method

    public static void main (String argv[]) {

        int result = run(argv, System.out);

        System.exit(result + PASS_BASE);

    }

    public static int run (String argv[], PrintStream out) {

        return new locationsofline_ssi001().runThis(argv, out);

    }

    //--------------------------------------------------   log procedures

    private static Log  logHandler;

    private static void log1(String message) {

        logHandler.display(sHeader1 + message);

    }

    private static void log2(String message) {

        logHandler.display(sHeader2 + message);

    }

    private static void log3(String message) {

        logHandler.complain(sHeader3 + message);

    }

    //  ************************************************    test parameters

    private String debuggeeName =

        "nsk.jdi.ReferenceType.locationsOfLine_ssi.locationsofline_ssi001a";

    String mName = "nsk.jdi.ReferenceType.locationsOfLine_ssi";

    //====================================================== test program

    //------------------------------------------------------ common section

    static ArgumentHandler      argsHandler;

    static int waitTime;

    static VirtualMachine vm = null;

    static int  testExitCode = PASSED;

    //------------------------------------------------------ methods

    private int runThis (String argv[], PrintStream out) {

        Debugee debuggee;

        argsHandler     = new ArgumentHandler(argv);

        logHandler      = new Log(out, argsHandler);

        Binder binder   = new Binder(argsHandler, logHandler);

        if (argsHandler.verbose()) {

            debuggee = binder.bindToDebugee(debuggeeName + " -vbs");

        } else {

            debuggee = binder.bindToDebugee(debuggeeName);

        }

        waitTime = argsHandler.getWaitTime();

        IOPipe pipe     = new IOPipe(debuggee);

        debuggee.redirectStderr(out);

        debuggee.resume();

        String line = pipe.readln();

        if ((line == null) || !line.equals("ready")) {

            log3("signal received is not 'ready' but: " + line);

            return FAILED;

        } else {

            log2("'ready' recieved");

        }

        vm = debuggee.VM();

    //------------------------------------------------------  testing section

        log1("      TESTING BEGINS");

        for (int i = 0; ; i++) {

            pipe.println("newcheck");

            line = pipe.readln();

            if (line.equals("checkend")) {

                log2("     : returned string is 'checkend'");

                break ;

            } else if (!line.equals("checkready")) {

                log3("ERROR: returned string is not 'checkready'");

                testExitCode = FAILED;

                break ;

            }

            log1("new checkready: #" + i);

            //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ variable part

            List          locations = null;

            ReferenceType refType   = null;

            log2("      getting: List classes = vm.classesByName(mName + '.TestClass');");

            List classes = vm.classesByName(mName + ".TestClass");

            if (classes.size() != 1) {

                testExitCode = FAILED;

                log3("ERROR: classes.size() != 1");

                break ;

            }

            log2("...... getting : String defaultStratum = vm.getDefaultStratum();");

            String defaultStratum = vm.getDefaultStratum();

            log2("      getting a tested ReferenceType object 'refType'");

            refType = (ReferenceType) classes.get(0);

            log2("......locations = refType.allLineLocations(); no AbsentInformationException is expected");

            try {

                locations = refType.allLineLocations();

            } catch ( AbsentInformationException e ) {

                testExitCode = FAILED;

                log3("ERROR: AbsentInformationException");

                log3("       ATTENTION:     see the README file to this test");

                break ;

            }

            log2("......checking up on a value of locations.size(); 0 is not expected");

            int size = locations.size();

            if (size == 0) {

                testExitCode = FAILED;

                log3("ERROR: locations.size() == 0");

                break ;

            }

            ListIterator li1 = locations.listIterator();

            log2("......the loop of checking locations in the returned list;");

            log2("      AbsentInformationException is not expected");

            label1:

                for (int ifor1 = 0; ifor1 < size; ifor1++) {

                    int lineNumber = ((Location) li1.next()).lineNumber();

                    try {

                        log2("......List lineLocations = refType.locationsOfLine(defaultStratum, null, " + lineNumber + ");");

                        List lineLocations = refType.locationsOfLine(defaultStratum, null, lineNumber);

                        int size1 = lineLocations.size();

                        if (size1 == 0) {

                            testExitCode = FAILED;

                            log3("ERROR: lineLocations.size() == 0");

                            break label1;

                        }

                        ListIterator li2 = lineLocations.listIterator();

                        try {

                            for (; li2.hasNext(); ) {

                                Location loc = (Location) li2.next();

                            }

                        } catch ( ClassCastException e) {

                             testExitCode = FAILED;

                             log3("ERROR: ClassCastException, that is, element is not Location");

                             break label1;

                        }

                    } catch ( AbsentInformationException e2 ) {

                        testExitCode = FAILED;

                        log3("ERROR: AbsentInformationException");

                        log3("       ATTENTION:     see the README file to this test");

                        break label1;

                    }

                }

            //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        }

        log1("      TESTING ENDS");

    //--------------------------------------------------   test summary section

    //-------------------------------------------------    standard end section

        pipe.println("quit");

        log2("waiting for the debuggee to finish ...");

        debuggee.waitFor();

        int status = debuggee.getStatus();

        if (status != PASSED + PASS_BASE) {

            log3("debuggee returned UNEXPECTED exit status: " +

                    status + " != PASS_BASE");

            testExitCode = FAILED;

        } else {

            log2("debuggee returned expected exit status: " +

                    status + " == PASS_BASE");

        }

        if (testExitCode != PASSED) {

             logHandler.complain("TEST FAILED");

        }

        return testExitCode;

    }

}