/*
 * Copyright (c) 2002, 2024, 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 nsk.jdi.Method._bounds_;

import com.sun.jdi.*;
import com.sun.jdi.connect.*;
import com.sun.jdi.request.*;

import java.io.*;
import java.util.*;

import nsk.share.*;
import nsk.share.jpda.*;
import nsk.share.jdi.*;


/**
 * The test checks up the following methods of <code>com.sun.jdi.Method</code>: <br>
 *
 *  - <code>locationsOfLine(int)</code> for boundary values of Integer          <br>
 *
 *  - <code>locationsOfLine(String, String, int)</code> for boundary values of
 * <code>Integer</code> and various combinations of value of String arguments
 * such as <code>(null, "", <bad_string>)</code>, where
 * <code><bad_string></code> means the some names of nonexisting object.        <br>
 *
 *  - <code>variablesByName(String)</code> for various combinations of value
 * of String arguments (see the notes above)                                    <br>
 *
 *  - <code>locationOfCodeIndex(long)</code> for boundary values
 * of <code>Long</code>                                                         <br>
 *
 *  - <code>equals(Object)</code> for <code>null</code> value                   <br>
 *
 *  - <code>bytecodes()</code> is checked on length of return array             <br>
 *
 * These checking are performed for native and non-native methods.
 */
public class bounds001 {

    private final static String prefix = "nsk.jdi.Method._bounds_.";
    private final static String debuggerName = prefix + "bounds001";
    private final static String debugeeName = debuggerName + "a";
    private final static String classWithNativeMethod = "java.lang.System";
    private final static String nativeMethod = "currentTimeMillis";


    public final static String SGNL_READY = "ready";
    public final static String SGNL_QUIT = "quit";

    public static int exitStatus;
    public static Log log;
    public static Debugee debugee;

    private static String propertyValue = "something";
    private static int lineNumbers[] = {
                                        Integer.MIN_VALUE,
                                        -1,
                                        Integer.MAX_VALUE
    };

    private static long codeIndexes[] = {
                                        Long.MIN_VALUE,
                                        -1,
                                        Long.MAX_VALUE
    };

    private static String[][] strParams = {
        {null,               null                  },
        {null,               ""                    },
        {null,               "bounds001_hotchpotch"},
        {"",                 null                  },
        {"",                 ""                    },
        {"",                 "bounds001_hotchpotch"},
        {"bounds001_jumble", null                  },
        {"bounds001_jumble", ""                    },
        {"bounds001_jumble", "bounds001_hotchpotch"}
    };

//----------------------------------------------------

    public static void display(String msg) {
        log.display(msg);
    }

    public static void complain(String msg) {
        log.complain("debugger FAILURE> " + msg + "\n");
    }

    public static void main(String argv[]) {
        int result = run(argv,System.out);
        if (result != 0) {
            throw new RuntimeException("TEST FAILED with result " + result);
        }
    }

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

        exitStatus = Consts.TEST_PASSED;

        bounds001 thisTest = new bounds001();

        ArgumentHandler argHandler = new ArgumentHandler(argv);
        log = new Log(out, argHandler);

        debugee = Debugee.prepareDebugee(argHandler, log, debugeeName);

        thisTest.execTest();
        display("Test finished. exitStatus = " + exitStatus);

        return exitStatus;
    }

    private void execTest() {

        ReferenceType testedClass = debugee.classByName(debugeeName);
        Method method = methodByName(testedClass, bounds001a.justMethod);

        ReferenceType classNM = debugee.classByName(classWithNativeMethod);
        Method nativeM = methodByName(classNM, nativeMethod);

        display("\nTEST BEGINS");
        display("===========");

        checkMethod(method);

        display("=============");

        checkMethod(nativeM);

        display("=============");
        display("TEST FINISHES\n");

        debugee.resume();
        debugee.quit();
    }

    private void checkMethod(Method method) {
        List list = null;
        display("");
        display(">checking method: " + method);
        display(">is native? " + method.isNative());

        display("invoking locationsOfLine(int):");
        display("------------------------------");
        for (int i = 0; i < lineNumbers.length; i++) {
            display("\tparameter: " + lineNumbers[i]);
            try {
                list = method.locationsOfLine(lineNumbers[i]);
                display("\tsize of locations list: " + list.size());
                if (list.size() > 0) {
                    complain("\twrong size");
                    exitStatus = Consts.TEST_FAILED;
                }
            } catch (Exception e) {
                complain("\tUnexpected: " + e);
                exitStatus = Consts.TEST_FAILED;
            }
            display("");
        }

        display("invoking locationsOfLine(String, String, int):");
        display("----------------------------------------------");
        for (int i = 0; i < lineNumbers.length; i++) {
            for (int j = 0; j < strParams.length; j++) {
                display("\tparameters: \"" + strParams[j][0] + "\", \""
                            + strParams[j][1] + "\", " + lineNumbers[i]);
                try {
                    list = method.locationsOfLine(strParams[j][0], strParams[j][1],
                                                        lineNumbers[i]);
                    display("\tsize of locations list: " + list.size());
                    if (list.size() > 0) {
                        complain("\twrong size");
                        exitStatus = Consts.TEST_FAILED;
                    }
                } catch (Exception e) {
                    complain("\tUnexpected: " + e);
                    exitStatus = Consts.TEST_FAILED;
                }
                display("");
            }
        }

        display("invoking variablesByName(String):");
        display("---------------------------------");
        for (int j = 0; j < strParams.length; j++) {
            display("\tparameter: \"" + strParams[j][0] + "\"");
            try {
                list = method.variablesByName(strParams[j][0]);
                display("\tsize of variables list: " + list.size());
                if (list.size() > 0) {
                    complain("\twrong size");
                    exitStatus = Consts.TEST_FAILED;
                }
            } catch (AbsentInformationException e) {
                if (method.isNative()) {
                    display("\tExpected: " + e);
                } else {
                    complain("\tUnexpected: " + e);
                    exitStatus = Consts.TEST_FAILED;
                }
            } catch (Exception e) {
                complain("\tUnexpected: " + e);
                exitStatus = Consts.TEST_FAILED;
            }
            display("");
            j += 2;
        }


        Location loc;
        display("invoking locationOfCodeIndex(long):");
        display("-----------------------------------");
        for (int i = 0; i < codeIndexes.length; i++) {
            display("\tparameter: " + codeIndexes[i]);
            try {
                loc = method.locationOfCodeIndex(codeIndexes[i]);
                display("\tlocation: " + loc);
                if (loc != null) {
                    complain("\twrong location");
                    exitStatus = Consts.TEST_FAILED;
                }
            } catch (Exception e) {
                complain("\tUnexpected: " + e);
                exitStatus = Consts.TEST_FAILED;
            }
            display("");
        }

        display("invoking equals(Object):");
        display("----------------------");
        display("\tparameter: <null>");
        try {
            if (!method.equals(null)) {
                display("\tis not equal to <null>");
            } else {
                complain("\tis equal to <null>");
                exitStatus = Consts.TEST_FAILED;
            }
        } catch (Exception e) {
            complain("\tUnexpected: " + e);
            exitStatus = Consts.TEST_FAILED;
        }
        display("");


        byte[] bytes;
        display("invoking bytecodes():");
        display("---------------------");
        try {
            bytes = method.bytecodes();
            display("\tsize of byte codes: " + bytes.length);
            if (method.isNative()) {
                if (bytes.length > 0) {
                    complain("\twrong size");
                    exitStatus = Consts.TEST_FAILED;
                }
            } else {
                if (bytes.length == 0) {
                    complain("\twrong size");
                    exitStatus = Consts.TEST_FAILED;
                }
            }
        } catch (Exception e) {
            complain("\tUnexpected: " + e);
            exitStatus = Consts.TEST_FAILED;
        }
        display("");
   }

    private Method methodByName(ReferenceType refType, String methodName) {
        List methodList = refType.methodsByName(methodName);
        if (methodList == null) return null;
        Method method = (Method )methodList.get(0);
        return method;
    }
}