/*
 * Copyright (c) 2000, 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 nsk.jdi.ReferenceType.visibleFields;

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

import com.sun.jdi.*;
import java.util.*;
import java.io.*;

/**
 * This test checks the method <code>visibleFields()</code>
 * of the JDI interface <code>ReferenceType</code> of com.sun.jdi package
 */

public class visibfield001 extends Log {
    static java.io.PrintStream out_stream;
    static boolean verbose_mode = false;  // test argument -vbs or -verbose switches to static
                                          // - for more easy failure evaluation

    /** The main class names of the debugger & debugee applications. */
    private final static String
        package_prefix = "nsk.jdi.ReferenceType.visibleFields.",
//        package_prefix = "",    //  for DEBUG without package
        thisClassName = package_prefix + "visibfield001",
        debugeeName   = thisClassName + "a";

    /** Debugee's classes for check **/
    private final static String class_for_check = package_prefix + "visibfield001aClassForCheck";
    private final static String not_visible_sign = "NOT VISIBLE";
    private final static String passed_sign = "PASSED";
    private static String fields_for_check[][] = {

//        field name                    type name             static    check result
        {"s_boolean_field",            "boolean",            " static",  not_visible_sign },
        {"s_byte_field",               "byte",               " static",  not_visible_sign },
        {"s_char_field",               "char",               " static",  not_visible_sign },
        {"s_double_field",             "double",             " static",  not_visible_sign },
        {"s_float_field",              "float",              " static",  not_visible_sign },
        {"s_int_field",                "int",                " static",  not_visible_sign },
        {"s_long_field",               "long",               " static",  not_visible_sign },
        {"s_object_field",             "java.lang.Object",   " static",  not_visible_sign },
        {"s_prim_array_field",         "long[]",             " static",  not_visible_sign },
        {"s_ref_array_field",          "java.lang.Object[]", " static",  not_visible_sign },
        {"i_boolean_field",            "boolean",            "",         not_visible_sign },
        {"i_byte_field",               "byte",               "",         not_visible_sign },
        {"i_char_field",               "char",               "",         not_visible_sign },
        {"i_double_field",             "double",             "",         not_visible_sign },
        {"i_float_field",              "float",              "",         not_visible_sign },
        {"i_int_field",                "int",                "",         not_visible_sign },
        {"i_long_field",               "long",               "",         not_visible_sign },
        {"i_object_field",             "java.lang.Object",   "",         not_visible_sign },
        {"i_prim_array_field",         "long[]",             "",         not_visible_sign },
        {"i_ref_array_field",          "java.lang.Object[]", "",         not_visible_sign },
        {"s_super_hidden_prim_field",  "int",                " static",  not_visible_sign },
        {"s_super_hidden_ref_field",   "java.lang.Class",    " static",  not_visible_sign },
        {"i_super_hidden_prim_field",  "int",                " static",  not_visible_sign },
        {"i_super_hidden_ref_field",   "java.lang.Class",    " static",  not_visible_sign },
        {"s_interf_hidden_prim_field", "int",                " static",  not_visible_sign },
        {"s_interf_hidden_ref_field",  "java.lang.Class",    " static",  not_visible_sign },
        {"s_super_boolean_field",      "boolean",            " static",  not_visible_sign },
        {"s_super_byte_field",         "byte",               " static",  not_visible_sign },
        {"s_super_char_field",         "char",               " static",  not_visible_sign },
        {"s_super_double_field",       "double",             " static",  not_visible_sign },
        {"s_super_float_field",        "float",              " static",  not_visible_sign },
        {"s_super_int_field",          "int",                " static",  not_visible_sign },
        {"s_super_long_field",         "long",               " static",  not_visible_sign },
        {"s_super_object_field",       "java.lang.Object",   " static",  not_visible_sign },
        {"i_super_boolean_field",      "boolean",            "",         not_visible_sign },
        {"i_super_byte_field",         "byte",               "",         not_visible_sign },
        {"i_super_char_field",         "char",               "",         not_visible_sign },
        {"i_super_double_field",       "double",             "",         not_visible_sign },
        {"i_super_float_field",        "float",              "",         not_visible_sign },
        {"i_super_int_field",          "int",                "",         not_visible_sign },
        {"i_super_long_field",         "long",               "",         not_visible_sign },
        {"i_super_object_field",       "java.lang.Object",   "",         not_visible_sign },
        {"s_interf_boolean_field",     "boolean",            " static",  not_visible_sign },
        {"s_interf_byte_field",        "byte",               " static",  not_visible_sign },
        {"s_interf_char_field",        "char",               " static",  not_visible_sign },
        {"s_interf_double_field",      "double",             " static",  not_visible_sign },
        {"s_interf_float_field",       "float",              " static",  not_visible_sign },
        {"s_interf_int_field",         "int",                " static",  not_visible_sign },
        {"s_interf_long_field",        "long",               " static",  not_visible_sign },
        {"s_interf_object_field",      "java.lang.Object",   " static",  not_visible_sign }

    };

    /**
     * Re-call to <code>run(args,out)</code>, and exit with
     * either status 95 or 97 (JCK-like exit status).
     */
    public static void main (String argv[]) {
        int exitCode = run(argv,System.out);
        System.exit(exitCode + 95/*STATUS_TEMP*/);
    }

    /**
     * JCK-like entry point to the test: perform testing, and
     * return exit code 0 (PASSED) or either 2 (FAILED).
     */
    public static int run (String argv[], PrintStream out) {
        out_stream = out;

        int v_test_result = new visibfield001().runThis(argv,out_stream);
        if ( v_test_result == 2/*STATUS_FAILED*/ ) {
            out_stream.println("\n==> nsk/jdi/ReferenceType/visibleFields/visibfield001 test FAILED");
        }
        else {
            out_stream.println("\n==> nsk/jdi/ReferenceType/visibleFields/visibfield001 test PASSED");
        }
        return v_test_result;
    }

    private void print_log_on_verbose(String message) {
        display(message);
    }

    /**
     * Non-static variant of the method <code>run(args,out)</code>
     */
    private int runThis (String argv[], PrintStream out) {
        ArgumentHandler argHandler = new ArgumentHandler(argv);
        verbose_mode = argHandler.verbose();

        if ( out_stream == null ) {
            out_stream = out;
        }

        out_stream.println("==> nsk/jdi/ReferenceType/visibleFields/visibfield001 test LOG:");
        out_stream.println("==> test checks visibleFields() method of ReferenceType interface ");
        out_stream.println("    of the com.sun.jdi package\n");

        String debugee_launch_command = debugeeName;
        if (verbose_mode) {
            logTo(out_stream);
        }

        Binder binder = new Binder(argHandler,this);
        Debugee debugee = binder.bindToDebugee(debugee_launch_command);
        IOPipe pipe = new IOPipe(debugee);

        debugee.redirectStderr(out);
        print_log_on_verbose("--> visibfield001: visibfield001a debugee launched");
        debugee.resume();

        String line = pipe.readln();
        if (line == null) {
            out_stream.println
                ("##> visibfield001: UNEXPECTED debugee's signal (not \"ready\") - " + line);
            return 2/*STATUS_FAILED*/;
        }
        if (!line.equals("ready")) {
            out_stream.println
                ("##> visibfield001: UNEXPECTED debugee's signal (not \"ready\") - " + line);
            return 2/*STATUS_FAILED*/;
        }
        else {
            print_log_on_verbose("--> visibfield001: debugee's \"ready\" signal recieved!");
        }

        out_stream.println
            ("--> visibfield001: check ReferenceType.visibleFields() method for debugee's "
            + class_for_check + " class...");
        boolean class_not_found_error = false;
        boolean visibleFields_method_error = false;
        int fields_for_check_number = fields_for_check.length;
        int not_visible_fields_number = 0;
        int visible_fields_number = 0;
        int unexpected_visible_fields_number = 0;

        while ( true ) {
            ReferenceType refType = debugee.classByName(class_for_check);
            if (refType == null) {
                out_stream.println("##> visibfield001: Could NOT FIND class: " + class_for_check);
                class_not_found_error = true;
                break;
            }
            List<Field> visible_fields_list = null;
            try {
                visible_fields_list = refType.visibleFields();
            }
            catch (Throwable thrown) {
                out_stream.println("##> visibfield001: FAILED: ReferenceType.visibleFields() throws unexpected "
                    + thrown);
                visibleFields_method_error = true;
                break;
            }
            visible_fields_number = visible_fields_list.size();
            Field visible_fields[] = new Field[visible_fields_number];
            String unexpected_visible_fields[] = new String[visible_fields_number];
            visible_fields_list.toArray(visible_fields);
            for (int i=0; i<visible_fields_number; i++) {
                Field checked_field = visible_fields[i];
                String checked_field_name = checked_field.name();
                String checked_field_typename = checked_field.typeName();
                String checked_field_static;
                if ( checked_field.isStatic() ) {
                    checked_field_static = " static";
                }
                else {
                    checked_field_static = "";
                }
                String full_checked_field = checked_field_static
                    + " " + checked_field_typename + " " + checked_field_name;
                int j=0;
                for (; j<fields_for_check_number; j++) {
                    if ( checked_field_name.equals(fields_for_check[j][0]) ) {
                        if ( (checked_field_typename.equals(fields_for_check[j][1]))
                                && (checked_field_static.equals(fields_for_check[j][2])) ) {
                            fields_for_check[j][3] = passed_sign;
                            break;
                        }
                    }
                }
                if ( j == fields_for_check_number ) {
                    //  unexpected visible field found
                    unexpected_visible_fields[unexpected_visible_fields_number] = full_checked_field;
                    unexpected_visible_fields_number++;
                }
            }
            for (int i=0; i<fields_for_check_number; i++) {
                String current_field_for_check = fields_for_check[i][2]
                    + " " + fields_for_check[i][1] + " " + fields_for_check[i][0];
                if ( fields_for_check[i][3].equals(not_visible_sign) ) {
                    out_stream.println
                        ("##> visibfield001: FAILED: field is NOT visible: " + current_field_for_check);
                    not_visible_fields_number++;
                }
                else {
                    print_log_on_verbose
                        ("--> visibfield001: PASSED for field: " + current_field_for_check);
                }
            }
            for (int i=0; i<unexpected_visible_fields_number; i++) {
                out_stream.println
                    ("##> visibfield001: FAILED: unexpected visible field: " + unexpected_visible_fields[i]);
            }
            break;
        }

        out_stream.println("--> visibfield001: check completed!");
        int v_test_result = 0/*STATUS_PASSED*/;
        if ( class_not_found_error || visibleFields_method_error ) {
            v_test_result = 2/*STATUS_FAILED*/;
        }
        else {
            out_stream.println("--> visibfield001: expected visible fields number = " + fields_for_check_number);
            out_stream.println("--> visibfield001: in fact visible fields number  = " + visible_fields_number);
            out_stream.println("--> visibfield001: expected and in fact visible fields number  = "
                + (fields_for_check_number - not_visible_fields_number));
            out_stream.println
                ("##> visibfield001: NOT visible fields number = " + not_visible_fields_number);
            out_stream.println
                ("##> visibfield001: UNEXPECTED visible fields number = " + unexpected_visible_fields_number);
        }
        if ( not_visible_fields_number + unexpected_visible_fields_number > 0 ) {
            v_test_result = 2/*STATUS_FAILED*/;
        }

        print_log_on_verbose("--> visibfield001: waiting for debugee finish...");
        pipe.println("quit");
        debugee.waitFor();

        int status = debugee.getStatus();
        if (status != 0/*STATUS_PASSED*/ + 95/*STATUS_TEMP*/) {
            out_stream.println
                ("##> visibfield001: UNEXPECTED Debugee's exit status (not 95) - " + status);
            v_test_result = 2/*STATUS_FAILED*/;
        }
        else {
            print_log_on_verbose
                ("--> visibfield001: expected Debugee's exit status - " + status);
        }

        return v_test_result;
    }
}
