/*
* Copyright (c) 2009, 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.object;
import java.awt.*;
import java.awt.event.*;
import java.util.List;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.table.*;
import com.sun.max.ins.*;
import com.sun.max.ins.debug.*;
import com.sun.max.ins.gui.*;
import com.sun.max.ins.memory.*;
import com.sun.max.ins.type.*;
import com.sun.max.ins.util.*;
import com.sun.max.ins.value.*;
import com.sun.max.tele.*;
import com.sun.max.tele.object.*;
import com.sun.max.unsafe.*;
import com.sun.max.vm.layout.Layout.HeaderField;
import com.sun.max.vm.type.*;
import com.sun.max.vm.value.*;
/**
* A table that displays the header in a heap object; for use in an instance of {@link ObjectView}.
*/
public final class ObjectHeaderTable extends InspectorTable {
private final ObjectView view;
private final HeaderField[] headerFields;
private final ObjectHeaderTableModel tableModel;
private final class ToggleObjectHeaderWatchpointAction extends InspectorAction {
private final int row;
public ToggleObjectHeaderWatchpointAction(Inspection inspection, String name, int row) {
super(inspection, name);
this.row = row;
}
@Override
protected void procedure() {
final List<MaxWatchpoint> watchpoints = tableModel.getWatchpoints(row);
if (watchpoints.isEmpty()) {
final HeaderField headerField = headerFields[row];
actions().setHeaderWatchpoint(view.object(), headerField, "Watch this field's memory").perform();
} else {
actions().removeWatchpoints(watchpoints, null).perform();
}
}
}
/**
* A {@link JTable} specialized to display object header fields.
*
* @param objectView parent that contains this panel
*/
public ObjectHeaderTable(Inspection inspection, ObjectView objectView) {
super(inspection);
this.view = objectView;
headerFields = view.object().headerFields();
this.tableModel = new ObjectHeaderTableModel(inspection, view.object().origin());
ObjectHeaderColumnModel columnModel = new ObjectHeaderColumnModel(this, this.tableModel, objectView.viewPreferences());
configureMemoryTable(tableModel, columnModel);
setBorder(BorderFactory.createMatteBorder(3, 0, 0, 0, preference().style().defaultBorderColor()));
updateFocusSelection();
}
@Override
protected void mouseButton1Clicked(int row, int col, MouseEvent mouseEvent) {
if (mouseEvent.getClickCount() > 1 && vm().watchpointManager() != null) {
final InspectorAction action = new ToggleObjectHeaderWatchpointAction(inspection(), null, row);
action.perform();
}
}
@Override
protected InspectorPopupMenu getPopupMenu(int row, int col, MouseEvent mouseEvent) {
if (vm().watchpointManager() != null) {
final InspectorPopupMenu menu = new InspectorPopupMenu();
menu.add(new ToggleObjectHeaderWatchpointAction(inspection(), "Toggle watchpoint (double-click)", row));
final HeaderField headerField = headerFields[row];
menu.add(actions().setHeaderWatchpoint(view.object(), headerField, "Watch this field's memory"));
menu.add(actions().setObjectWatchpoint(view.object(), "Watch this object's memory"));
menu.add(Watchpoints.createEditMenu(inspection(), tableModel.getWatchpoints(row)));
menu.add(Watchpoints.createRemoveActionOrMenu(inspection(), tableModel.getWatchpoints(row)));
return menu;
}
return null;
}
@Override
public void updateFocusSelection() {
// Sets table selection to the memory word, if any, that is the current user focus.
final Address address = focus().address();
updateSelection(tableModel.findRow(address));
}
@Override
public void valueChanged(ListSelectionEvent e) {
// The selection in the table has changed; might have happened via user action (click, arrow) or
// as a side effect of a focus change.
super.valueChanged(e);
if (!e.getValueIsAdjusting()) {
final int row = getSelectedRow();
if (row >= 0 && row < tableModel.getRowCount()) {
focus().setAddress(tableModel.getAddress(row));
}
}
}
/**
* {@inheritDoc}.
* <br>
* Color the text specially in the row where a watchpoint is triggered
*/
@Override
public Color cellForegroundColor(int row, int col) {
final MaxWatchpointEvent watchpointEvent = vm().state().watchpointEvent();
if (watchpointEvent != null && tableModel.getMemoryRegion(row).contains(watchpointEvent.address())) {
return preference().style().debugIPTagColor();
}
return null;
}
@Override
public Color cellBackgroundColor() {
return view == null ? null : view.viewBackgroundColor();
}
@Override
public Color headerBackgroundColor() {
return cellBackgroundColor();
}
public ObjectView getView() {
return view;
}
/**
* A column model for object headers, to be used in an {@link ObjectView}. Column selection is driven by
* choices in the parent {@link ObjectView}. This implementation cannot update column choices dynamically.
*/
private final class ObjectHeaderColumnModel extends InspectorTableColumnModel<ObjectColumnKind> {
ObjectHeaderColumnModel(InspectorTable table, InspectorMemoryTableModel tableModel, ObjectViewPreferences viewPreferences) {
super(inspection(), ObjectColumnKind.values().length, viewPreferences);
addColumnIfSupported(ObjectColumnKind.TAG, new MemoryTagTableCellRenderer(inspection(), table, tableModel), null);
addColumnIfSupported(ObjectColumnKind.ADDRESS, new MemoryAddressLocationTableCellRenderer(inspection(), ObjectHeaderTable.this, tableModel), null);
addColumnIfSupported(ObjectColumnKind.OFFSET, new MemoryOffsetLocationTableCellRenderer(inspection(), ObjectHeaderTable.this, tableModel), null);
addColumnIfSupported(ObjectColumnKind.TYPE, new MemoryContentsTypeTableCellRenderer(inspection(), ObjectHeaderTable.this, tableModel), null);
addColumnIfSupported(ObjectColumnKind.NAME, new NameRenderer(inspection()), null);
addColumnIfSupported(ObjectColumnKind.VALUE, new ValueRenderer(inspection()), null);
addColumnIfSupported(ObjectColumnKind.BYTES, new MemoryBytesTableCellRenderer(inspection(), table, tableModel), null);
addColumnIfSupported(ObjectColumnKind.REGION, new MemoryRegionPointerTableCellRenderer(inspection(), table, tableModel), null);
}
}
/**
* Models the words/rows in an object header; the value of each cell is simply the word/row number.
* <br>
* The origin of the model is the current origin of the object in memory, which can change due to GC.
*/
private final class ObjectHeaderTableModel extends InspectorMemoryTableModel {
private TeleHub teleHub;
public ObjectHeaderTableModel(Inspection inspection, Address origin) {
super(inspection, origin);
if (view.object().status().isNotDead()) {
teleHub = view.object().getTeleHub();
}
}
public int getColumnCount() {
return ObjectColumnKind.values().length;
}
public int getRowCount() {
return headerFields.length;
}
public Object getValueAt(int row, int col) {
return row;
}
@Override
public Class<?> getColumnClass(int col) {
return Integer.class;
}
@Override
public Address getAddress(int row) {
return getOrigin().plus(getOffset(row));
}
@Override
public MaxMemoryRegion getMemoryRegion(int row) {
return view.object().headerMemoryRegion(headerFields[row]);
}
@Override
public int getOffset(int row) {
return view.object().headerOffset(headerFields[row]);
}
@Override
public int findRow(Address address) {
for (int row = 0; row < headerFields.length; row++) {
if (getAddress(row).equals(address)) {
return row;
}
}
return -1;
}
@Override
public String getRowDescription(int row) {
return "Header field \"" + headerFields[row].name + "\"";
}
@Override
public TypeDescriptor getRowType(int row) {
return view.object().headerType(headerFields[row]);
}
public String rowToHeaderDescription(int row) {
return headerFields[row].description;
}
public String rowToName(int row) {
return headerFields[row].toString();
}
public TeleHub teleHub() {
return teleHub;
}
@Override
public void refresh() {
setOrigin(view.object().origin());
if (view.object().status().isNotDead()) {
teleHub = view.object().getTeleHub();
}
super.refresh();
}
}
private final class NameRenderer extends JavaNameLabel implements TableCellRenderer {
public NameRenderer(Inspection inspection) {
super(inspection);
setOpaque(true);
}
public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
setToolTipPrefix(tableModel.getRowDescription(row) + "<br>");
setValue(tableModel.rowToName(row), "Description = \"" + tableModel.rowToHeaderDescription(row) + "\"");
setForeground(cellForegroundColor(row, column));
setBackground(cellBackgroundColor());
return this;
}
}
private final class ValueRenderer implements TableCellRenderer, Prober {
private final InspectorLabel[] labels = new InspectorLabel[headerFields.length];
private boolean live = true;
public ValueRenderer(Inspection inspection) {
final MaxObject object = view.object();
for (int row = 0; row < headerFields.length; row++) {
// Create a label suitable for the kind of header field
HeaderField headerField = headerFields[row];
if (headerField == HeaderField.HUB) {
labels[row] = new WordValueLabel(inspection, WordValueLabel.ValueMode.HUB_REFERENCE, ObjectHeaderTable.this) {
@Override
public Value fetchValue() {
final TeleHub teleHub = tableModel.teleHub();
if (teleHub == null) {
return WordValue.ZERO;
}
final Address hubFieldAddress = object.headerAddress(HeaderField.HUB);
return vm().memoryIO().readWordValue(hubFieldAddress);
}
};
} else if (headerField == HeaderField.MISC) {
labels[row] = new MiscWordLabel(inspection, object);
} else if (headerField == HeaderField.LENGTH) {
switch (object.kind()) {
case ARRAY:
final TeleArrayObject teleArrayObject = (TeleArrayObject) object;
labels[row] = new PrimitiveValueLabel(inspection, Kind.INT) {
@Override
public Value fetchValue() {
return IntValue.from(teleArrayObject.length());
}
};
break;
case HYBRID:
final TeleHybridObject teleHybridObject = (TeleHybridObject) object;
labels[row] = new PrimitiveValueLabel(inspection, Kind.INT) {
@Override
public Value fetchValue() {
return IntValue.from(teleHybridObject.readArrayLength());
}
};
break;
case TUPLE:
// No length header field
break;
default:
InspectorError.unknownCase();
}
} else {
final HeaderField finalHeaderField = headerField;
labels[row] = new WordValueLabel(inspection, WordValueLabel.ValueMode.WORD, ObjectHeaderTable.this) {
@Override
public Value fetchValue() {
final Address headerFieldAddress = object.headerAddress(finalHeaderField);
return vm().memoryIO().readWordValue(headerFieldAddress);
}
};
}
labels[row].setOpaque(true);
}
}
public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
final InspectorLabel inspectorLabel = labels[row];
inspectorLabel.setBackground(cellBackgroundColor());
return inspectorLabel;
}
public void redisplay() {
for (InspectorLabel label : labels) {
label.redisplay();
}
}
public void refresh(boolean force) {
if (live && !view.object().status().isLive()) {
// The object has died since the last time we looked; replace the labels to read general word values.
for (int row = 0; row < headerFields.length; row++) {
final HeaderField finalHeaderField = headerFields[row];
labels[row] = new WordValueLabel(inspection(), WordValueLabel.ValueMode.WORD, ObjectHeaderTable.this) {
@Override
public Value fetchValue() {
final Address headerFieldAddress = view.object().headerAddress(finalHeaderField);
return vm().memoryIO().readWordValue(headerFieldAddress);
}
};
}
live = false;
}
for (InspectorLabel label : labels) {
label.refresh(force);
}
}
}
}