/*
 * Copyright (c) 2007, 2012, 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 com.sun.max.ins.method;

import static com.sun.max.ins.gui.AbstractView.MenuKind.*;

import com.sun.max.ins.*;
import com.sun.max.ins.gui.*;
import com.sun.max.ins.view.InspectionViews.*;
import com.sun.max.tele.*;
import com.sun.max.tele.object.*;

/**
 * Visual view and debugger for code discovered in the VM that is not compiled Java.
 * It is runtime assembled code such as a stub or
 * is other native code about which little is known.
 */
public final class NativeMethodView extends MethodView<NativeMethodView> {

    private final MaxNativeFunction nativeFunction;
    private MachineCodeViewer machineCodeViewer = null;
    private final String shortName;
    private final String longName;

    public NativeMethodView(Inspection inspection, MethodViewContainer container, MaxNativeFunction externalCode) {
        super(inspection, container);
        this.nativeFunction = externalCode;
        shortName = inspection().nameDisplay().shortName(externalCode);
        longName = inspection().nameDisplay().longName(externalCode);
        final InspectorFrame frame = createTabFrame(container);
        // The default menu operates from the perspective of the parent container.
        frame.makeMenu(DEFAULT_MENU).add(defaultMenuItems(DEFAULT_MENU, container));

        frame.makeMenu(EDIT_MENU);

        final InspectorMenu memoryMenu = frame.makeMenu(MEMORY_MENU);
        memoryMenu.add(views().memory().makeViewAction(externalCode.memoryRegion(), externalCode.entityName(), "View memory for machine code"));
        memoryMenu.add(defaultMenuItems(MEMORY_MENU));
        memoryMenu.add(views().activateSingletonViewAction(ViewKind.ALLOCATIONS));

        frame.makeMenu(OBJECT_MENU).add(defaultMenuItems(OBJECT_MENU));

        frame.makeMenu(CODE_MENU).add(defaultMenuItems(CODE_MENU));

        frame.makeMenu(DEBUG_MENU).add(defaultMenuItems(DEBUG_MENU));

        frame.makeMenu(VIEW_MENU).add(defaultMenuItems(VIEW_MENU));
    }

    @Override
    public MaxNativeFunction compilation() {
        return nativeFunction;
    }

    @Override
    public TeleClassMethodActor teleClassMethodActor() {
        return null;
    }

    @Override
    public String getTextForTitle() {
        return shortName;
    }

    @Override
    public String getToolTip() {
        return "native function:  " + longName;
    }

    @Override
    public void createViewContent() {
        machineCodeViewer =  new JTableMachineCodeViewer(inspection(), this, nativeFunction);
        getContentPane().add(machineCodeViewer);
        validate();
    }

    @Override
    protected void refreshState(boolean force) {
        if (getJComponent().isShowing() || force) {
            machineCodeViewer.refresh(force);
        }
    }

    @Override
    public void viewConfigurationChanged() {
        machineCodeViewer.redisplay();
    }

    @Override
    public void print() {
        machineCodeViewer.print(getTextForTitle());
    }

    /**
     * Receive request from codeViewer to close; there's only one, so close the whole Method view.
     */
    @Override
    public void closeCodeViewer(CodeViewer codeViewer) {
        assert codeViewer == machineCodeViewer;
        close();
    }

    /**
     * Global code selection has changed; update viewer.
     */
    @Override
    public void codeLocationFocusSet(MaxCodeLocation codeLocation, boolean interactiveForNative) {
        if (machineCodeViewer.updateCodeFocus(codeLocation) && !isSelected()) {
            highlight();
        }
    }
}